From be4adb7c2681e82c81c25902bb5e4964229a79a2 Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Sat, 29 Apr 2023 06:01:25 +0800 Subject: [PATCH 01/79] pull out common chart of sdk generation (#23768) --- .../typespec-end-to-end-scenarios.md | 114 ++++++++++-------- 1 file changed, 66 insertions(+), 48 deletions(-) diff --git a/documentation/typespec-end-to-end-scenarios.md b/documentation/typespec-end-to-end-scenarios.md index b975ea218a52..692e58482147 100644 --- a/documentation/typespec-end-to-end-scenarios.md +++ b/documentation/typespec-end-to-end-scenarios.md @@ -5,7 +5,7 @@ It is crucial having simple and smooth processes that allow developer to easily: 1. [Scaffolding TypeSpec project in `rest-api-specs` repo](#1-typespec-project-scaffolding) -2. [Scaffolding SDK projects in SDK repos](#2-sdk-project-scaffolding) +2. [SDK code generation in SDK repos](#2-sdk-code-generation) 1. All SDK required information (SDK path, namespace etc) should be set in `tspconfig.yaml`. 2. Single call via `eng/scripts` in each language repo to complete the task 3. Optional, intelligent CI pipeline component to create related PRs when a new service API PR is submitted. @@ -58,7 +58,7 @@ class A,G,D,F grey ##### Details & Open questions -#### 2. SDK project scaffolding +#### 2. SDK code generation ##### Flowchart ```mermaid @@ -69,20 +69,52 @@ User((::))-->A A["clone Rest-API and SDK repo locally"] --> B B["2.1 pre-requsite dependencies installation (each language would have a installation script)"] --> C -C["2.2 create sdk project scaffolding - (e.g. Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1)"
This should create tsp_location.yaml from referencing the source tspconfig.yaml] --> D - D["- tsp-location.yaml is created.
- User update commit hash - (need a new script)"] -D-->E[2.3 Running Sync & Generate script] -E-->F[SDK code can be compiled and PR submitted] -class A,D,F grey +C["2.2 TypeSpec-Project-Sync.ps1 +(a.create tsp-location.yaml and drop to temp location +b.update tsp-location.yaml if existed +c.fetch specs from remote spec repo or use local spec repo)"] --> D + D["2.3 TypeSpec-Project-Generate.ps1 +(a.create scaffolding for new project +b.update tsp-location.yaml +c.copy typespec specs to temp folder +d.generate sdk code)"] +D-->E["code build"] +class A,E grey +class C,D highlight ``` +- 2.2 `TypeSpec-Project-Sync.ps1` + - input: + - sdkProjectDirectory + - typespecProjectDirectory + - repo + - commit + - additionalDirectories + - localMode (use local spec and don't fetch from remote) + - localSpecRepoPath + Note: we might pull out tsp-location.yaml create/update part as single script to be used by #2 scenario + - output: + - path of sdkProjectDirectory + +- Function `Get-{Language}-Tsp-Location-Path` + - input: sdkProjectDirectory + - output: path of tsp-location.yaml + +- 2.3 `TypeSpec-Project-Generate.ps1` + - input: + - projectDirectory + - typespecAdditionalOptions (emitter options) + +- Function `Generate-{Language}-New-Project-Scaffolding` + - input: path of tsp-location.yaml + ##### Remaining Tasks | Step | Step Detail | Assignee | Implemented | Verified | |--|--|--|--:|--:| | 2.1 | Dependencies scripts | SDK owner | [ ] | [] | -| 2.2 | creating SDK folder & `tsp-location.yaml` | Michael, EngSys | [ ] | | [ ] | -| 2.3 | Sync & Generate script | Michael, EngSys | [ ] | | [ ] | +| 2.2 | common script | EngSys | [ ] | | [ ] | +| 2.3 | common script | EngSys | [ ] | | [ ] | +| 2.4 | language script to call common script | SDK owner | [] | [] +| 2.5 | update to dotnet build target | Michael, Crystal | [] | [] ##### Details & Open questions - 2.1 Optional: Scripts should exists under `\eng\scripts\` folder on all repos. @@ -94,23 +126,31 @@ class A,D,F grey flowchart TD; classDef highlight fill:#ffd700 User((::))-->A + A A["clone spec repo and clone sdk repo"]-->B - B-->B B["... iterate on .tsp specs"]-->C C["tsp compile ."]-->D - D["copy all related files to spec repo folder + D["optional:copy all related files to spec repo folder if it's not there (*.tsp,*.json,tspconfig.yaml)"]-->E D-->F - E["create API spec PR"] - F["docker run ..."]-->I - D-->G - G["TypeSpec-Project-Sync.ps1 - (on cloned sdk repo folder)"]-->H - H["TypeSpec-Project-Generate.ps1"]-->I + E["create API spec PR"]-->|loop|B + F["docker run + (a. call `initScript` - 2.1 + b. call `generateScript` + (2.2 + 2.3) )"]-->I + D-->K + K["optional:2.1"]-->G + G["2.2"]-->H + H["2.3"]-->I I["build code and work on test,sample,readme,etc."]-->J + I-->|loop|B J["create sdk PR"] - class G,H highlight + class F,G,H highlight ``` +- Note: docker run command is + ``` + docker run -it --privileged -v {local_spec_repo_path}:/spec-repo -v {local_work_folder}:/work-dir -v sdkgeneration.azurecr.io/sdk-generation:latest --typespec-project={relative_typespec_project} --sdk={sdk_to_generate} + ``` ##### Remaining Tasks | Step | Step Detail | Assignee | Implemented | Verified | |--|--|--|--:|--:| @@ -152,20 +192,13 @@ A["filter SDK languages to be generated B["get language scripts path for `initScript` and `generateScript` (from codegen_to_sdk_config.json)"]-->C C["run `initScript` -(dependencies installation)"]-->E +(2.1)"]-->G subgraph D["run `generateScript`"] - E G H end -E["create sdk project scaffolding if it's a new service -(e.g. Invoke-TypeSpecDataPlaneGenerateSDKPackage.ps1)"]-->G -G["TypeSpec-Project-Sync.ps1 -(a.create/update tsp-location.yaml -b.fetch specs from remote spec repo or use local spec repo -c.then copy typespec specs to temp folder)"]-->H -H["TypeSpec-Project-Generate.ps1 -(generate sdk code)"]-->I +G["2.2"]-->H +H["2.3"]-->I I["package sdk code"]-->J J["optional:build code and run test"]-->K K["upload artifacts"]-->L @@ -192,21 +225,6 @@ M["generate apiView"] - changelog - artifacts -- `TypeSpec-Project-Sync.ps1` - - input: - - projectDirectory - - repo - - commit - - additionalDirectories - - localMode (use local spec and don't fetch from remote) - - localSpecRepoPath -Note: we might pull out tsp-location.yaml create/update part as single script to be used by #2 scenario - -- `TypeSpec-Project-Generate.ps1` - - input: - - projectDirectory - - typespecAdditionalOptions (emitter options) - ##### 4.2 Outer Dev loop SDK repo pipeline ###### Flowchart ```mermaid @@ -215,7 +233,7 @@ flowchart TD; classDef automationStep fill:#7de188 Pipeline((::))-->A A["run `initScript` -(dependencies installation)"]-->C +(2.1)"]-->C subgraph B["run `generateScript`"] C D @@ -223,11 +241,11 @@ subgraph B["run `generateScript`"] F G end -C["TypeSpec-Project-Sync.ps1 +C["2.2 (a.use existing tsp-location.yaml b.fetch specs from remote spec repo c.then copy typespec specs to temp folder)"]-->D -D["TypeSpec-Project-Generate.ps1 +D["2.3 (generate sdk code)"]-->E E["package sdk code"]-->F F["build code"]-->G From aeb7bf01df887ea6095e1c3d545c2445c9d8dde7 Mon Sep 17 00:00:00 2001 From: Wes Haggard Date: Mon, 1 May 2023 17:26:24 -0700 Subject: [PATCH 02/79] Update prettier version and normalize all files (#23763) Remove unecessary prettier scripts --- documentation/ci-fix.md | 14 +- package-lock.json | 415 ++++++++---------- package.json | 20 +- scripts/prettier-check.ts | 22 - scripts/utils.ts | 81 ---- .../cloud-events-schema/keyvalue_deleted.json | 2 +- .../keyvalue_modified.json | 2 +- .../export_rdb_completed.json | 2 +- .../import_rdb_completed.json | 2 +- .../patching_completed.json | 2 +- .../scaling_completed.json | 2 +- .../chat_message_deleted_in_thread.json | 2 +- .../chat_message_edited.json | 2 +- .../chat_message_edited_in_thread.json | 2 +- .../chat_message_received.json | 2 +- .../chat_message_received_in_thread.json | 2 +- ...participant_added_to_thread_with_user.json | 2 +- ...icipant_removed_from_thread_with_user.json | 2 +- .../chat_thread_created.json | 2 +- .../chat_thread_created_withUser.json | 2 +- .../chat_thread_deleted.json | 2 +- .../chat_thread_participant_added.json | 2 +- .../chat_thread_participant_removed.json | 2 +- .../chat_thread_properties_updated.json | 2 +- ...at_thread_properties_updated_per_user.json | 2 +- .../chat_thread_with_user_deleted.json | 2 +- .../recording_file_status_updated.json | 2 +- .../sms_delivery_report_received.json | 2 +- .../cloud-events-schema/sms_received.json | 2 +- .../user_disconnected.json | 2 +- .../event-grid-schema/sms_received.json | 2 +- .../cloud-events-schema/chart_deleted.json | 2 +- .../cloud-events-schema/chart_pushed.json | 2 +- .../cloud-events-schema/image_deleted.json | 2 +- .../cloud-events-schema/image_pushed.json | 2 +- .../new_kubernetes_version_available.json | 2 +- .../cloud-events-schema/device_connected.json | 2 +- .../cloud-events-schema/device_created.json | 2 +- .../cloud-events-schema/device_telemetry.json | 2 +- .../stable/2018-01-01/EventGrid.json | 3 +- .../capture_file_created.json | 2 +- .../secret_new_version_created.json | 2 +- .../dataset_drift_detected.json | 2 +- .../cloud-events-schema/model_deployed.json | 2 +- .../cloud-events-schema/model_registered.json | 2 +- .../cloud-events-schema/run_completed.json | 2 +- .../run_status_changed.json | 2 +- .../cloud-events-schema/geofence_entered.json | 2 +- .../cloud-events-schema/geofence_result.json | 2 +- ...LiveEventChannelArchiveHeartbeatEvent.json | 2 +- .../MediaLiveEventIngestHeartbeatEvent.json | 2 +- .../policy_state_changed.json | 2 +- .../policy_state_created.json | 2 +- .../resource_action_cancel.json | 2 +- .../resource_action_failure.json | 2 +- .../resource_action_success.json | 2 +- .../resource_delete_cancel.json | 2 +- .../resource_delete_failure.json | 2 +- .../resource_delete_success.json | 2 +- .../resource_write_cancel.json | 2 +- .../resource_write_failure.json | 2 +- .../resource_write_success.json | 2 +- ...ages_available_periodic_notifications.json | 2 +- ..._messages_available_with_no_listeners.json | 2 +- ...sages_available_periodic_notification.json | 2 +- ..._messages_available_with_no_listeners.json | 2 +- .../client_connection_connected.json | 2 +- .../client_connection_disconnected.json | 2 +- .../cloud-events-schema/blob_created.json | 2 +- .../cloud-events-schema/blob_deleted.json | 2 +- .../blob_inventory_policy_completed.json | 2 +- .../cloud-events-schema/blob_renamed.json | 2 +- .../blob_tier_changed.json | 2 +- .../directory_created.json | 2 +- .../directory_deleted.json | 2 +- .../directory_renamed.json | 2 +- .../app_service_plan_updated.json | 2 +- .../app_updated_changed_app_settings.json | 2 +- .../app_updated_restarted.json | 2 +- .../app_updated_stopped.json | 2 +- .../backup_operation_completed.json | 2 +- .../backup_operation_failed.json | 2 +- .../backup_operation_started.json | 2 +- .../restore_operation_completed.json | 2 +- .../restore_operation_failed.json | 2 +- .../restore_operation_started.json | 2 +- .../slot_swap_completed.json | 2 +- .../cloud-events-schema/slot_swap_failed.json | 2 +- .../slot_swap_started.json | 2 +- .../slot_swap_with_preview_cancelled.json | 2 +- .../slot_swap_with_preview_started.json | 2 +- 91 files changed, 282 insertions(+), 443 deletions(-) delete mode 100644 scripts/prettier-check.ts delete mode 100644 scripts/utils.ts diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index 316c2e571f2a..e00f0be43a3f 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -10,18 +10,14 @@ If your problem is some existing error name that is not a word and need to supre ## Prettier check -Please run the following command (from an administrator Node.js command prompt if running on Windows): +To update all the spec files for a given service run the following: ``` +# To fix a particular service swagger cd to that directory like +cd specification/contosowidgetmanager +# to fix all the files in the repo run from the root of the repo npm install -npm run prettier-fix -``` - -Or if you want to fix specified service, use the complete path, not relative: - -``` -npm install -npm run prettier -- --write "/azure-rest-api-specs/specification/**/*.json" +npx prettier -w **/*.json ``` Then please commit and push changes made by prettier. diff --git a/package-lock.json b/package-lock.json index b4c49f230355..1cd4880d9b51 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,7 +5,8 @@ "packages": { "": { "name": "azure-rest-api-specs", - "dependencies": { + "hasInstallScript": true, + "devDependencies": { "@azure-tools/cadl-apiview": "0.3.5", "@azure-tools/cadl-autorest": "0.26.0", "@azure-tools/cadl-azure-core": "0.26.0", @@ -16,14 +17,11 @@ "@azure-tools/typespec-azure-core": "0.29.0", "@azure-tools/typespec-azure-resource-manager": "0.29.0", "@azure-tools/typespec-providerhub": "0.29.0", - "@typespec/compiler": "0.43.0" - }, - "devDependencies": { "@azure/avocado": "^0.8.4", - "@types/prettier": "^2.6.1", - "prettier": "^2.7.1", - "ts-node": "^10.1.0", - "typescript": "^3.5.3" + "@types/prettier": "^2.7.2", + "@typespec/compiler": "0.43.0", + "prettier": "^2.8.8", + "typescript": "~5.0.4" } }, "node_modules/@azure-tools/cadl-apiview": { @@ -31,6 +29,7 @@ "resolved": "https://registry.npmjs.org/@azure-tools/cadl-apiview/-/cadl-apiview-0.3.5.tgz", "integrity": "sha512-1+g/I7/PzEQQv8jE7HyxBKYSru+Ji0Myuviuy2qK8TE8gYcBoGjRdNb1aIIYyJpuqkazJ5hLtEKDD9enVhMNoA==", "deprecated": "Package renamed to @azure-tools/typespec-apiview.", + "dev": true, "dependencies": { "@azure-tools/cadl-autorest": "0.26.0", "@azure-tools/cadl-azure-core": "0.26.0", @@ -43,22 +42,11 @@ "node": ">=16.0.0" } }, - "node_modules/@azure-tools/cadl-apiview/node_modules/@azure-tools/cadl-dpg": { - "version": "0.26.0", - "resolved": "https://registry.npmjs.org/@azure-tools/cadl-dpg/-/cadl-dpg-0.26.0.tgz", - "integrity": "sha512-/F40cUDwKZVPj+dBWxdZ3rXwiqs0kGV6ra/LcNoqK+M+nacd48R4L0512izfJbm8KqFen8yh9jfVC8xQfB6bJg==", - "engines": { - "node": ">=16.0.0" - }, - "peerDependencies": { - "@cadl-lang/compiler": "~0.40.0", - "@cadl-lang/rest": "~0.40.0" - } - }, "node_modules/@azure-tools/cadl-autorest": { "version": "0.26.0", "resolved": "https://registry.npmjs.org/@azure-tools/cadl-autorest/-/cadl-autorest-0.26.0.tgz", "integrity": "sha512-CoMddqhtZ7lP6O3hbX7Qxq3QeOou64IBmuf4Iz8dcTHOaLfrSoiJshbczEgO/mV62sY5kTmdamWEIi5ZRUpvWA==", + "dev": true, "engines": { "node": ">=16.0.0" }, @@ -74,6 +62,7 @@ "version": "0.26.0", "resolved": "https://registry.npmjs.org/@azure-tools/cadl-azure-core/-/cadl-azure-core-0.26.0.tgz", "integrity": "sha512-PYmG/cp+QhyjuQa0jwTkkPp487d500FmPUB5rhjjx+OG080322d+uLeS9tx25dEq3GRoehEnF80qkupBjZBr1g==", + "dev": true, "dependencies": { "@cadl-lang/lint": "~0.40.0" }, @@ -89,6 +78,7 @@ "version": "0.26.0", "resolved": "https://registry.npmjs.org/@azure-tools/cadl-azure-resource-manager/-/cadl-azure-resource-manager-0.26.0.tgz", "integrity": "sha512-0SVf/c5vZH6aCD05Ni7FjpGtKfd5bP8JqPFslhQyxqL9i3ILPso5xS1MOfFBI51L2gxy5ranSgGzTz3TOotiXw==", + "dev": true, "dependencies": { "@cadl-lang/lint": "~0.40.0" }, @@ -104,10 +94,24 @@ "@cadl-lang/versioning": "~0.40.0" } }, + "node_modules/@azure-tools/cadl-dpg": { + "version": "0.26.0", + "resolved": "https://registry.npmjs.org/@azure-tools/cadl-dpg/-/cadl-dpg-0.26.0.tgz", + "integrity": "sha512-/F40cUDwKZVPj+dBWxdZ3rXwiqs0kGV6ra/LcNoqK+M+nacd48R4L0512izfJbm8KqFen8yh9jfVC8xQfB6bJg==", + "dev": true, + "engines": { + "node": ">=16.0.0" + }, + "peerDependencies": { + "@cadl-lang/compiler": "~0.40.0", + "@cadl-lang/rest": "~0.40.0" + } + }, "node_modules/@azure-tools/cadl-providerhub": { "version": "0.26.0", "resolved": "https://registry.npmjs.org/@azure-tools/cadl-providerhub/-/cadl-providerhub-0.26.0.tgz", "integrity": "sha512-SZWnsuQziw2XJ7audHCpeYGmr1SMVOouqhqQPCSlMMo23elGmWnV+ThB3bso2t7m7PqPjGAhZZNsupQhVbWByg==", + "dev": true, "engines": { "node": ">=16.0.0" }, @@ -125,6 +129,7 @@ "version": "0.4.4", "resolved": "https://registry.npmjs.org/@azure-tools/typespec-apiview/-/typespec-apiview-0.4.4.tgz", "integrity": "sha512-9F8+wx7Nl5USPDo2d9QClDjZyDLXNF/kJ23lb50goIuskePsFBzlb4KlaUc3Xehy7kPanR/E4zH9f0lLm2tGXg==", + "dev": true, "engines": { "node": ">=16.0.0" }, @@ -137,6 +142,7 @@ "version": "0.29.0", "resolved": "https://registry.npmjs.org/@azure-tools/typespec-autorest/-/typespec-autorest-0.29.0.tgz", "integrity": "sha512-am5qSHlW8/X0o9FaLGNDydgVnGpXlTI88fgN1JU08xP1PPO5jnLIhYPCoqyPsp3bxC7j9YILRgppfvTkTQtdUQ==", + "dev": true, "engines": { "node": ">=16.0.0" }, @@ -153,6 +159,7 @@ "version": "0.29.0", "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-core/-/typespec-azure-core-0.29.0.tgz", "integrity": "sha512-JJ8o/aCDdt1clrPeKwQloXqPPMO146ifdhQd69GAenR/OfmzUnuc23ubkzYcgs5fmH+5i37fKsxGhFGFDJiL1g==", + "dev": true, "dependencies": { "@typespec/lint": "~0.43.0" }, @@ -169,6 +176,7 @@ "version": "0.29.0", "resolved": "https://registry.npmjs.org/@azure-tools/typespec-azure-resource-manager/-/typespec-azure-resource-manager-0.29.0.tgz", "integrity": "sha512-bNLLlu/TC+Jg4MST7bhoXoccR22c07S1ROqXyRdzmyBeTf5azsSDswBdo+UNQSzeqi74/ik42O52yglhvFOfOw==", + "dev": true, "dependencies": { "@typespec/lint": "~0.43.0" }, @@ -189,6 +197,7 @@ "version": "0.29.0", "resolved": "https://registry.npmjs.org/@azure-tools/typespec-providerhub/-/typespec-providerhub-0.29.0.tgz", "integrity": "sha512-44DR6x/0pVuKv5jcc0DaJOhH6ewp26SI/TH8By9CW43v4eHHCpo4qNPBVM5x4Q7i4xCttyk9E9OHYspqpk0ahQ==", + "dev": true, "engines": { "node": ">=16.0.0" }, @@ -292,6 +301,7 @@ "version": "7.18.6", "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.18.6.tgz", "integrity": "sha512-TDCmlK5eOvH+eH7cdAFlNXeVJqWIQ7gW9tY1GJIpUtFb6CmjVyq2VM3u71bOyR8CRihcCgMUYoDNyLXao3+70Q==", + "dev": true, "dependencies": { "@babel/highlight": "^7.18.6" }, @@ -303,6 +313,7 @@ "version": "7.19.1", "resolved": "https://registry.npmjs.org/@babel/helper-validator-identifier/-/helper-validator-identifier-7.19.1.tgz", "integrity": "sha512-awrNfaMtnHUr653GgGEs++LlAvW6w+DcPrOliSMXWCKo597CwL5Acf/wWdNkf/tfEQE3mjkeD1YOVZOUV/od1w==", + "dev": true, "engines": { "node": ">=6.9.0" } @@ -311,6 +322,7 @@ "version": "7.18.6", "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.18.6.tgz", "integrity": "sha512-u7stbOuYjaPezCuLj29hNW1v64M2Md2qupEKP1fHc7WdOA3DgLh37suiSrZYY7haUB7iBeQZ9P1uiRF359do3g==", + "dev": true, "dependencies": { "@babel/helper-validator-identifier": "^7.18.6", "chalk": "^2.0.0", @@ -324,6 +336,7 @@ "version": "0.40.0", "resolved": "https://registry.npmjs.org/@cadl-lang/compiler/-/compiler-0.40.0.tgz", "integrity": "sha512-4u/Dnm39Ma+8wH0SDu7ya1+2oBRDiNByiRoijwyScHRec26UWLyWvHMvvU89ISU6O8Vwtq0bpmbD7FeJTnlbHw==", + "dev": true, "dependencies": { "@babel/code-frame": "~7.18.6", "ajv": "~8.11.2", @@ -353,6 +366,7 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, "dependencies": { "color-convert": "^2.0.1" }, @@ -366,12 +380,14 @@ "node_modules/@cadl-lang/compiler/node_modules/argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==" + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true }, "node_modules/@cadl-lang/compiler/node_modules/cliui": { "version": "8.0.1", "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", + "dev": true, "dependencies": { "string-width": "^4.2.0", "strip-ansi": "^6.0.1", @@ -385,6 +401,7 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, "dependencies": { "color-name": "~1.1.4" }, @@ -395,12 +412,14 @@ "node_modules/@cadl-lang/compiler/node_modules/color-name": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true }, "node_modules/@cadl-lang/compiler/node_modules/js-yaml": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, "dependencies": { "argparse": "^2.0.1" }, @@ -412,6 +431,7 @@ "version": "3.2.8", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.2.8.tgz", "integrity": "sha512-KtpD1YhGszhntMpBDyp5lyagk8KIMopC1LEb7cQUAh7zcosaX5uK8HnbNb2i3NTQK3sIawCItS0uFC3QzcLHdg==", + "dev": true, "dependencies": { "data-uri-to-buffer": "^4.0.0", "fetch-blob": "^3.1.4", @@ -429,6 +449,7 @@ "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, "dependencies": { "ansi-styles": "^4.0.0", "string-width": "^4.1.0", @@ -445,6 +466,7 @@ "version": "5.0.8", "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "dev": true, "engines": { "node": ">=10" } @@ -453,6 +475,7 @@ "version": "17.6.2", "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.6.2.tgz", "integrity": "sha512-1/9UrdHjDZc0eOU0HxOHoS78C69UD3JRMvzlJ7S79S2nTaWRA/whGCTV8o9e/N/1Va9YIV7Q4sOxD8VV4pCWOw==", + "dev": true, "dependencies": { "cliui": "^8.0.1", "escalade": "^3.1.1", @@ -470,6 +493,7 @@ "version": "21.1.1", "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "dev": true, "engines": { "node": ">=12" } @@ -478,6 +502,7 @@ "version": "0.40.0", "resolved": "https://registry.npmjs.org/@cadl-lang/lint/-/lint-0.40.0.tgz", "integrity": "sha512-V/V5Msuurhb7kVZsvuAKVAHq4twmC5YC5k/t7YJWETOowFXepgIneWJPH2TDyyzO9WqJjqRJVRXPTrTuKuNFsA==", + "dev": true, "engines": { "node": ">=16.0.0" }, @@ -489,6 +514,7 @@ "version": "0.40.0", "resolved": "https://registry.npmjs.org/@cadl-lang/openapi/-/openapi-0.40.0.tgz", "integrity": "sha512-M2/Pb5AyZd2O5ycYBIoIf4bufip7bCUTMt3gdom1ss6726APbG1fxx98HPcTbXXx0oA+SuqEXtz8k9eaUGLadQ==", + "dev": true, "peer": true, "engines": { "node": ">=16.0.0" @@ -502,6 +528,7 @@ "version": "0.40.0", "resolved": "https://registry.npmjs.org/@cadl-lang/rest/-/rest-0.40.0.tgz", "integrity": "sha512-WfGq6lN87adRKsKd3XtztvOLXHzyFlDRQiEcXKfnwXia37zVwK355KX39P1RimQ9mpDsmXaGG4ETkdUSWvXe7w==", + "dev": true, "engines": { "node": ">=16.0.0" }, @@ -513,6 +540,7 @@ "version": "0.40.0", "resolved": "https://registry.npmjs.org/@cadl-lang/versioning/-/versioning-0.40.0.tgz", "integrity": "sha512-HK/jw0kxo/6RwbnR7nPyCj2kJ94uZbBhEmS08ms+fX4UB4nDNBXqXFwMwgftVZ2qdS9xEkRhLqpVYfEPzlFBJw==", + "dev": true, "dependencies": { "@cadl-lang/compiler": "~0.40.0" }, @@ -520,47 +548,11 @@ "node": ">=16.0.0" } }, - "node_modules/@cspotcode/source-map-support": { - "version": "0.8.1", - "resolved": "https://registry.npmjs.org/@cspotcode/source-map-support/-/source-map-support-0.8.1.tgz", - "integrity": "sha512-IchNf6dN4tHoMFIn/7OE8LWZ19Y6q/67Bmf6vnGREv8RSbBVb9LPJxEcnwrcwX6ixSvaiGoomAUvu4YSxXrVgw==", - "dev": true, - "dependencies": { - "@jridgewell/trace-mapping": "0.3.9" - }, - "engines": { - "node": ">=12" - } - }, - "node_modules/@jridgewell/resolve-uri": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/@jridgewell/resolve-uri/-/resolve-uri-3.1.0.tgz", - "integrity": "sha512-F2msla3tad+Mfht5cJq7LSXcdudKTWCVYUgw6pLFOOHSTtZlj6SWNYAp+AhuqLmWdBO2X5hPrLcu8cVP8fy28w==", - "dev": true, - "engines": { - "node": ">=6.0.0" - } - }, - "node_modules/@jridgewell/sourcemap-codec": { - "version": "1.4.14", - "resolved": "https://registry.npmjs.org/@jridgewell/sourcemap-codec/-/sourcemap-codec-1.4.14.tgz", - "integrity": "sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==", - "dev": true - }, - "node_modules/@jridgewell/trace-mapping": { - "version": "0.3.9", - "resolved": "https://registry.npmjs.org/@jridgewell/trace-mapping/-/trace-mapping-0.3.9.tgz", - "integrity": "sha512-3Belt6tdc8bPgAtbcmdtNJlirVoTmEb5e2gC94PnkwEW9jI6CAHUeoG85tjWP5WquqfavoMtMwiG4P926ZKKuQ==", - "dev": true, - "dependencies": { - "@jridgewell/resolve-uri": "^3.0.3", - "@jridgewell/sourcemap-codec": "^1.4.10" - } - }, "node_modules/@nodelib/fs.scandir": { "version": "2.1.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz", "integrity": "sha512-vq24Bq3ym5HEQm2NKCr3yXDwjc7vTsEThRDnkp2DK9p1uqLR+DHurm/NOTo0KG7HYHU7eppKZj3MyqYuMBf62g==", + "dev": true, "dependencies": { "@nodelib/fs.stat": "2.0.5", "run-parallel": "^1.1.9" @@ -573,6 +565,7 @@ "version": "2.0.5", "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.5.tgz", "integrity": "sha512-RkhPPp2zrqDAQA/2jNhnztcPAlv64XdhIp7a7454A5ovI7Bukxgt7MX7udwAu3zg1DcpPU0rz3VV1SeaqvY4+A==", + "dev": true, "engines": { "node": ">= 8" } @@ -581,6 +574,7 @@ "version": "1.2.8", "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.8.tgz", "integrity": "sha512-oGB+UxlgWcgQkgwo8GcEGwemoTFt3FIO9ababBmaGwXIoBKZ+GTy0pP185beGg7Llih/NSHSV2XAs1lnznocSg==", + "dev": true, "dependencies": { "@nodelib/fs.scandir": "2.1.5", "fastq": "^1.6.0" @@ -673,12 +667,6 @@ "tslib": "^1.9.3" } }, - "node_modules/@ts-common/fs/node_modules/@types/node": { - "version": "10.17.60", - "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz", - "integrity": "sha512-F0KIgDJfy2nA3zMLmWGKxcH2ZVEtCZXHHdOQs2gSaQ27+lNeEfGxzkIw90aXswATX7AZ33tahPbzy6KAfUreVw==", - "dev": true - }, "node_modules/@ts-common/fs/node_modules/tslib": { "version": "1.14.1", "resolved": "https://registry.npmjs.org/tslib/-/tslib-1.14.1.tgz", @@ -815,30 +803,6 @@ } } }, - "node_modules/@tsconfig/node10": { - "version": "1.0.9", - "resolved": "https://registry.npmjs.org/@tsconfig/node10/-/node10-1.0.9.tgz", - "integrity": "sha512-jNsYVVxU8v5g43Erja32laIDHXeoNvFEpX33OK4d6hljo3jDhCBDhx5dhCCTMWUojscpAagGiRkBKxpdl9fxqA==", - "dev": true - }, - "node_modules/@tsconfig/node12": { - "version": "1.0.11", - "resolved": "https://registry.npmjs.org/@tsconfig/node12/-/node12-1.0.11.tgz", - "integrity": "sha512-cqefuRsh12pWyGsIoBKJA9luFu3mRxCA+ORZvA4ktLSzIuCUtWVxGIuXigEwO5/ywWFMZ2QEGKWvkZG1zDMTag==", - "dev": true - }, - "node_modules/@tsconfig/node14": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@tsconfig/node14/-/node14-1.0.3.tgz", - "integrity": "sha512-ysT8mhdixWK6Hw3i1V2AeRqZ5WfXg1G43mqoYlM2nc6388Fq5jcXyr5mRsqViLx/GJYdoL0bfXD8nmF+Zn/Iow==", - "dev": true - }, - "node_modules/@tsconfig/node16": { - "version": "1.0.3", - "resolved": "https://registry.npmjs.org/@tsconfig/node16/-/node16-1.0.3.tgz", - "integrity": "sha512-yOlFc+7UtL/89t2ZhjPvvB/DeAr3r+Dq58IgzsFkOAvVC6NMJXmCGjbptdXdR9qsX7pKcTL+s87FtYREi2dEEQ==", - "dev": true - }, "node_modules/@types/async-retry": { "version": "1.4.5", "resolved": "https://registry.npmjs.org/@types/async-retry/-/async-retry-1.4.5.tgz", @@ -849,21 +813,21 @@ } }, "node_modules/@types/commonmark": { - "version": "0.27.5", - "resolved": "https://registry.npmjs.org/@types/commonmark/-/commonmark-0.27.5.tgz", - "integrity": "sha512-vIqgmHyLsc8Or3EWLz6QkhI8/v61FNeH0yxRupA7VqSbA2eFMoHHJAhZSHudplAV89wqg1CKSmShE016ziRXuw==", + "version": "0.27.6", + "resolved": "https://registry.npmjs.org/@types/commonmark/-/commonmark-0.27.6.tgz", + "integrity": "sha512-t3S2hOtSSuBp1H5PTFmekGFu9U9LBzGvHy93zHwusvj4RIGUrBQ4zHvw49CkJtAl6fZvsadKhYbv8WTxJLbBmw==", "dev": true }, "node_modules/@types/node": { - "version": "18.15.3", - "resolved": "https://registry.npmjs.org/@types/node/-/node-18.15.3.tgz", - "integrity": "sha512-p6ua9zBxz5otCmbpb5D3U4B5Nanw6Pk3PPyX05xnxbB/fRv71N7CPmORg7uAD5P70T0xmx1pzAx/FUfa5X+3cw==", + "version": "10.17.60", + "resolved": "https://registry.npmjs.org/@types/node/-/node-10.17.60.tgz", + "integrity": "sha512-F0KIgDJfy2nA3zMLmWGKxcH2ZVEtCZXHHdOQs2gSaQ27+lNeEfGxzkIw90aXswATX7AZ33tahPbzy6KAfUreVw==", "dev": true }, "node_modules/@types/node-fetch": { - "version": "2.6.2", - "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.6.2.tgz", - "integrity": "sha512-DHqhlq5jeESLy19TYhLakJ07kNumXWjcDdxXsLUMJZ6ue8VZJj4kLPQVE/2mdHh3xZziNF1xppu5lwmS53HR+A==", + "version": "2.6.3", + "resolved": "https://registry.npmjs.org/@types/node-fetch/-/node-fetch-2.6.3.tgz", + "integrity": "sha512-ETTL1mOEdq/sxUtgtOhKjyB2Irra4cjxksvcMUR5Zr4n+PxVhsCD9WS46oPbHL3et9Zde7CNRr+WUNlcHvsX+w==", "dev": true, "dependencies": { "@types/node": "*", @@ -886,6 +850,7 @@ "version": "0.43.0", "resolved": "https://registry.npmjs.org/@typespec/compiler/-/compiler-0.43.0.tgz", "integrity": "sha512-VSOEuD8UMgySm8YhZ/9rvoZjyp8dp9y8arKjUjt3+uBnNQr8ZgbRbOBcxbauJuRYEO9i6dRvunf9rvLIvXyEEQ==", + "dev": true, "dependencies": { "@babel/code-frame": "~7.18.6", "ajv": "~8.11.2", @@ -915,6 +880,7 @@ "version": "4.3.0", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.3.0.tgz", "integrity": "sha512-zbB9rCJAT1rbjiVDb2hqKFHNYLxgtk8NURxZ3IZwD3F6NtxbXZQCnnSi1Lkx+IDohdPlFp222wVALIheZJQSEg==", + "dev": true, "dependencies": { "color-convert": "^2.0.1" }, @@ -928,12 +894,14 @@ "node_modules/@typespec/compiler/node_modules/argparse": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz", - "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==" + "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", + "dev": true }, "node_modules/@typespec/compiler/node_modules/cliui": { "version": "8.0.1", "resolved": "https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz", "integrity": "sha512-BSeNnyus75C4//NQ9gQt1/csTXyo/8Sb+afLAkzAptFuMsod9HFokGNudZpi/oQV73hnVK+sR+5PVRMd+Dr7YQ==", + "dev": true, "dependencies": { "string-width": "^4.2.0", "strip-ansi": "^6.0.1", @@ -947,6 +915,7 @@ "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, "dependencies": { "color-name": "~1.1.4" }, @@ -957,12 +926,14 @@ "node_modules/@typespec/compiler/node_modules/color-name": { "version": "1.1.4", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", - "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==" + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true }, "node_modules/@typespec/compiler/node_modules/js-yaml": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.1.0.tgz", "integrity": "sha512-wpxZs9NoxZaJESJGIZTyDEaYpl0FKSA+FB9aJiyemKhMwkxQg63h4T1KJgUGHpTqPDNRcmmYLugrRjJlBtWvRA==", + "dev": true, "dependencies": { "argparse": "^2.0.1" }, @@ -974,6 +945,7 @@ "version": "3.2.8", "resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-3.2.8.tgz", "integrity": "sha512-KtpD1YhGszhntMpBDyp5lyagk8KIMopC1LEb7cQUAh7zcosaX5uK8HnbNb2i3NTQK3sIawCItS0uFC3QzcLHdg==", + "dev": true, "dependencies": { "data-uri-to-buffer": "^4.0.0", "fetch-blob": "^3.1.4", @@ -991,6 +963,7 @@ "version": "7.0.0", "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-7.0.0.tgz", "integrity": "sha512-YVGIj2kamLSTxw6NsZjoBxfSwsn0ycdesmc4p+Q21c5zPuZ1pl+NfxVdxPtdHvmNVOQ6XSYG4AUtyt/Fi7D16Q==", + "dev": true, "dependencies": { "ansi-styles": "^4.0.0", "string-width": "^4.1.0", @@ -1007,6 +980,7 @@ "version": "5.0.8", "resolved": "https://registry.npmjs.org/y18n/-/y18n-5.0.8.tgz", "integrity": "sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA==", + "dev": true, "engines": { "node": ">=10" } @@ -1015,6 +989,7 @@ "version": "17.6.2", "resolved": "https://registry.npmjs.org/yargs/-/yargs-17.6.2.tgz", "integrity": "sha512-1/9UrdHjDZc0eOU0HxOHoS78C69UD3JRMvzlJ7S79S2nTaWRA/whGCTV8o9e/N/1Va9YIV7Q4sOxD8VV4pCWOw==", + "dev": true, "dependencies": { "cliui": "^8.0.1", "escalade": "^3.1.1", @@ -1032,6 +1007,7 @@ "version": "21.1.1", "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-21.1.1.tgz", "integrity": "sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==", + "dev": true, "engines": { "node": ">=12" } @@ -1040,6 +1016,7 @@ "version": "0.43.1", "resolved": "https://registry.npmjs.org/@typespec/http/-/http-0.43.1.tgz", "integrity": "sha512-tgXrEYmhW6xPMfi57sgfEIA+6N4QIVBqBmvU2s0xouAuqdmYWsulcJjewMHkzOdj0agRyEjNEfQLWkCTIQVl4A==", + "dev": true, "peer": true, "engines": { "node": ">=16.0.0" @@ -1052,6 +1029,7 @@ "version": "0.43.0", "resolved": "https://registry.npmjs.org/@typespec/lint/-/lint-0.43.0.tgz", "integrity": "sha512-Hs4zEws8+ZOu3wuN32dmAKOkvlmQzdpkd96Wyx8tT4j3aovf1APqlGjozgp9DZcKxpT+jAxpS+GLpjBTZEeUnQ==", + "dev": true, "engines": { "node": ">=16.0.0" }, @@ -1063,6 +1041,7 @@ "version": "0.43.0", "resolved": "https://registry.npmjs.org/@typespec/openapi/-/openapi-0.43.0.tgz", "integrity": "sha512-WDQopOJBGsUoztpNUtoYJ5gEJac0W5g8JGKqMaAmAjJ47Cq/BJh2NCrxJKZeFEhKI98zz13IQmRbcf1zmSLPJw==", + "dev": true, "peer": true, "engines": { "node": ">=16.0.0" @@ -1077,6 +1056,7 @@ "version": "0.43.0", "resolved": "https://registry.npmjs.org/@typespec/rest/-/rest-0.43.0.tgz", "integrity": "sha512-de+muAnsANmUtcLsBagrRxdylS4dLsEoPGpz7TQe52pBkog+bbtPTQqRM5TqwxwK//94yS3dEMNynFXE1Yey8Q==", + "dev": true, "peer": true, "engines": { "node": ">=16.0.0" @@ -1089,6 +1069,7 @@ "version": "0.43.0", "resolved": "https://registry.npmjs.org/@typespec/versioning/-/versioning-0.43.0.tgz", "integrity": "sha512-YxU9QPH05wF/8k0BjyR1pFTxA5qWxjeq8RyQtwFf+smz1pFbFLf7RmqEUZgXChC4H+7cwsIC8eLefx4ukObF9Q==", + "dev": true, "peer": true, "dependencies": { "@typespec/compiler": "~0.43.0" @@ -1097,31 +1078,11 @@ "node": ">=16.0.0" } }, - "node_modules/acorn": { - "version": "8.8.2", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.8.2.tgz", - "integrity": "sha512-xjIYgE8HBrkpd/sJqOGNspf8uHG+NOHGOw6a/Urj8taM2EXfdNAH2oFcPeIFfsv3+kz/mJrS5VuMqbNLjCa2vw==", - "dev": true, - "bin": { - "acorn": "bin/acorn" - }, - "engines": { - "node": ">=0.4.0" - } - }, - "node_modules/acorn-walk": { - "version": "8.2.0", - "resolved": "https://registry.npmjs.org/acorn-walk/-/acorn-walk-8.2.0.tgz", - "integrity": "sha512-k+iyHEuPgSw6SbuDpGQM+06HQUa04DZ3o+F6CSzXMvvI5KMvnaEqXe+YVe555R9nn6GPt404fos4wcgpw12SDA==", - "dev": true, - "engines": { - "node": ">=0.4.0" - } - }, "node_modules/ajv": { "version": "8.11.2", "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.11.2.tgz", "integrity": "sha512-E4bfmKAhGiSTvMfL1Myyycaub+cUEU2/IvpylXkUu7CHBkBj1f/ikdzbD7YQ6FKUbixDxeYvB/xY4fvyroDlQg==", + "dev": true, "dependencies": { "fast-deep-equal": "^3.1.1", "json-schema-traverse": "^1.0.0", @@ -1137,6 +1098,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", "integrity": "sha512-quJQXlTSUGL2LH9SUXo8VwsY4soanhgo6LNSm84E1LBcE8s3O0wpdiRzyR9z/ZZJMlMWv37qOOb9pdJlMUEKFQ==", + "dev": true, "engines": { "node": ">=8" } @@ -1145,6 +1107,7 @@ "version": "3.2.1", "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, "dependencies": { "color-convert": "^1.9.0" }, @@ -1152,12 +1115,6 @@ "node": ">=4" } }, - "node_modules/arg": { - "version": "4.1.3", - "resolved": "https://registry.npmjs.org/arg/-/arg-4.1.3.tgz", - "integrity": "sha512-58S9QDqG0Xx27YwPSt9fJxivjYl432YCwfDMfZ+71RAqUrZef7LrKQZ3LHLOwCS4FLNBplP533Zx895SeOCHvA==", - "dev": true - }, "node_modules/argparse": { "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", @@ -1202,6 +1159,7 @@ "version": "3.0.2", "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, "dependencies": { "fill-range": "^7.0.1" }, @@ -1213,6 +1171,7 @@ "version": "4.1.2", "resolved": "https://registry.npmjs.org/camel-case/-/camel-case-4.1.2.tgz", "integrity": "sha512-gxGWBrTT1JuMx6R+o5PTXMmUnhnVzLQ9SNutD4YqKtI6ap897t3tKECYla6gCWEkplXnlNybEkZg9GEGxKFCgw==", + "dev": true, "dependencies": { "pascal-case": "^3.1.2", "tslib": "^2.0.3" @@ -1231,6 +1190,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/capital-case/-/capital-case-1.0.4.tgz", "integrity": "sha512-ds37W8CytHgwnhGGTi88pcPyR15qoNkOpYwmMMfnWqqWgESapLqvDx6huFjQ5vqWSn2Z06173XNA7LtMOeUh1A==", + "dev": true, "dependencies": { "no-case": "^3.0.4", "tslib": "^2.0.3", @@ -1241,6 +1201,7 @@ "version": "2.4.2", "resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz", "integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==", + "dev": true, "dependencies": { "ansi-styles": "^3.2.1", "escape-string-regexp": "^1.0.5", @@ -1254,6 +1215,7 @@ "version": "4.1.2", "resolved": "https://registry.npmjs.org/change-case/-/change-case-4.1.2.tgz", "integrity": "sha512-bSxY2ws9OtviILG1EiY5K7NNxkqg/JnRnFxLtKQ96JaviiIxi7djMrSd0ECT9AC+lttClmYwKw53BWpOMblo7A==", + "dev": true, "dependencies": { "camel-case": "^4.1.2", "capital-case": "^1.0.4", @@ -1284,6 +1246,7 @@ "version": "1.9.3", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, "dependencies": { "color-name": "1.1.3" } @@ -1291,7 +1254,8 @@ "node_modules/color-name": { "version": "1.1.3", "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", - "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==" + "integrity": "sha512-72fSenhMw2HZMTVHeCA9KCmpEIbzWiQsjN+BHcBbS9vr1mtt+vJjPdksIBNUmKAW8TFUDPJK5SUU3QhE9NEXDw==", + "dev": true }, "node_modules/combined-stream": { "version": "1.0.8", @@ -1333,22 +1297,18 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/constant-case/-/constant-case-3.0.4.tgz", "integrity": "sha512-I2hSBi7Vvs7BEuJDr5dDHfzb/Ruj3FyvFyh7KLilAjNQw3Be+xgqUBA2W6scVEcL0hL1dwPRtIqEPVUCKkSsyQ==", + "dev": true, "dependencies": { "no-case": "^3.0.4", "tslib": "^2.0.3", "upper-case": "^2.0.2" } }, - "node_modules/create-require": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/create-require/-/create-require-1.1.1.tgz", - "integrity": "sha512-dcKFX3jn0MpIaXjisoRvexIJVEKzaq7z2rZKxf+MSr9TkdmHmsU4m2lcLojrj/FHl8mk5VxMmYA+ftRkP/3oKQ==", - "dev": true - }, "node_modules/data-uri-to-buffer": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/data-uri-to-buffer/-/data-uri-to-buffer-4.0.1.tgz", "integrity": "sha512-0R9ikRb668HB7QDxT1vkpuUBtqc53YyAwMwGeUFKRojY/NWKvdZ+9UYtRfGmhqNbRkTSVpMbmyhXipFFv2cb/A==", + "dev": true, "engines": { "node": ">= 12" } @@ -1371,19 +1331,11 @@ "node": ">=0.4.0" } }, - "node_modules/diff": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/diff/-/diff-4.0.2.tgz", - "integrity": "sha512-58lmxKSA4BNyLz+HHMUzlOEpg09FV+ev6ZMe3vJihgdxzgcwZ8VoEEPmALCZG9LmqfVoNMMKpttIYTVG6uDY7A==", - "dev": true, - "engines": { - "node": ">=0.3.1" - } - }, "node_modules/dir-glob": { "version": "3.0.1", "resolved": "https://registry.npmjs.org/dir-glob/-/dir-glob-3.0.1.tgz", "integrity": "sha512-WkrWp9GR4KXfKGYzOLmTuGVi1UWFfws377n9cc55/tb6DuqyF6pcQ5AbiHEshaDpY9v6oaSr2XCDidGmMwdzIA==", + "dev": true, "dependencies": { "path-type": "^4.0.0" }, @@ -1395,6 +1347,7 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/dot-case/-/dot-case-3.0.4.tgz", "integrity": "sha512-Kv5nKlh6yRrdrGvxeJ2e5y2eRUpkUosIW4A2AS38zwSz27zu7ufDwQPi5Jhs3XAlGNetl3bmnGhQsMtkKJnj3w==", + "dev": true, "dependencies": { "no-case": "^3.0.4", "tslib": "^2.0.3" @@ -1403,7 +1356,8 @@ "node_modules/emoji-regex": { "version": "8.0.0", "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-8.0.0.tgz", - "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==" + "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", + "dev": true }, "node_modules/entities": { "version": "2.0.3", @@ -1415,6 +1369,7 @@ "version": "3.1.1", "resolved": "https://registry.npmjs.org/escalade/-/escalade-3.1.1.tgz", "integrity": "sha512-k0er2gUkLf8O0zKJiAhmkTnJlTvINGv7ygDNPbeIsX/TJjGJZHuh9B2UxbsaEkmlEo9MfhrSzmhIlhRlI2GXnw==", + "dev": true, "engines": { "node": ">=6" } @@ -1423,6 +1378,7 @@ "version": "1.0.5", "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz", "integrity": "sha512-vbRorB5FUQWvla16U8R/qgaFIya2qGzwDrNmCZuYKrbdSUMG6I1ZCGQRefkRVhuOkIGVne7BQ35DSfo1qvJqFg==", + "dev": true, "engines": { "node": ">=0.8.0" } @@ -1443,12 +1399,14 @@ "node_modules/fast-deep-equal": { "version": "3.1.3", "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz", - "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==" + "integrity": "sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q==", + "dev": true }, "node_modules/fast-glob": { "version": "3.2.12", "resolved": "https://registry.npmjs.org/fast-glob/-/fast-glob-3.2.12.tgz", "integrity": "sha512-DVj4CQIYYow0BlaelwK1pHl5n5cRSJfM60UA0zK891sVInoPri2Ekj7+e1CT3/3qxXenpI+nBBmQAcJPJgaj4w==", + "dev": true, "dependencies": { "@nodelib/fs.stat": "^2.0.2", "@nodelib/fs.walk": "^1.2.3", @@ -1464,6 +1422,7 @@ "version": "1.15.0", "resolved": "https://registry.npmjs.org/fastq/-/fastq-1.15.0.tgz", "integrity": "sha512-wBrocU2LCXXa+lWBt8RoIRD89Fi8OdABODa/kEnyeyjS5aZO5/GNvI5sEINADqP/h8M29UHTHUb53sUu5Ihqdw==", + "dev": true, "dependencies": { "reusify": "^1.0.4" } @@ -1472,6 +1431,7 @@ "version": "3.2.0", "resolved": "https://registry.npmjs.org/fetch-blob/-/fetch-blob-3.2.0.tgz", "integrity": "sha512-7yAQpD2UMJzLi1Dqv7qFYnPbaPx7ZfFK6PiIxQ4PfkGPyNyl2Ugx+a/umUonmKqjhM4DnfbMvdX6otXq83soQQ==", + "dev": true, "funding": [ { "type": "github", @@ -1494,6 +1454,7 @@ "version": "7.0.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, "dependencies": { "to-regex-range": "^5.0.1" }, @@ -1532,6 +1493,7 @@ "version": "4.0.10", "resolved": "https://registry.npmjs.org/formdata-polyfill/-/formdata-polyfill-4.0.10.tgz", "integrity": "sha512-buewHzMvYL29jdeQTVILecSaZKnt/RJWjoZCF5OW60Z67/GmSLBkOFM7qh1PI3zFNtJbaZL5eQu1vLfazOwj4g==", + "dev": true, "dependencies": { "fetch-blob": "^3.1.2" }, @@ -1558,6 +1520,7 @@ "version": "2.0.5", "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "dev": true, "engines": { "node": "6.* || 8.* || >= 10.*" } @@ -1586,6 +1549,7 @@ "version": "5.1.2", "resolved": "https://registry.npmjs.org/glob-parent/-/glob-parent-5.1.2.tgz", "integrity": "sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==", + "dev": true, "dependencies": { "is-glob": "^4.0.1" }, @@ -1594,9 +1558,10 @@ } }, "node_modules/globby": { - "version": "13.1.3", - "resolved": "https://registry.npmjs.org/globby/-/globby-13.1.3.tgz", - "integrity": "sha512-8krCNHXvlCgHDpegPzleMq07yMYTO2sXKASmZmquEYWEmCx6J5UTRbp5RwMJkTJGtcQ44YpiUYUiN0b9mzy8Bw==", + "version": "13.1.4", + "resolved": "https://registry.npmjs.org/globby/-/globby-13.1.4.tgz", + "integrity": "sha512-iui/IiiW+QrJ1X1hKH5qwlMQyv34wJAYwH1vrf8b9kBA4sNiif3gKsMHa+BrdnOpEudWjpotfa7LrTzB1ERS/g==", + "dev": true, "dependencies": { "dir-glob": "^3.0.1", "fast-glob": "^3.2.11", @@ -1621,6 +1586,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz", "integrity": "sha512-sKJf1+ceQBr4SMkvQnBDNDtf4TXpVhVGateu0t918bl30FnbE2m4vNLX+VWe/dpjlb+HugGYzW7uQXH98HPEYw==", + "dev": true, "engines": { "node": ">=4" } @@ -1629,6 +1595,7 @@ "version": "2.0.4", "resolved": "https://registry.npmjs.org/header-case/-/header-case-2.0.4.tgz", "integrity": "sha512-H/vuk5TEEVZwrR0lp2zed9OCo1uAILMlx0JEMgC26rzyJJ3N1v6XkwHHXJQdR2doSjcGPM6OKPYoJgf0plJ11Q==", + "dev": true, "dependencies": { "capital-case": "^1.0.4", "tslib": "^2.0.3" @@ -1638,6 +1605,7 @@ "version": "5.2.4", "resolved": "https://registry.npmjs.org/ignore/-/ignore-5.2.4.tgz", "integrity": "sha512-MAb38BcSbH0eHNBxn7ql2NH/kX33OkB3lZ1BNdh7ENeRChHTYsTvWrMubiIAMNS2llXEEgZ1MUOBtXChP3kaFQ==", + "dev": true, "engines": { "node": ">= 4" } @@ -1677,6 +1645,7 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/is-extglob/-/is-extglob-2.1.1.tgz", "integrity": "sha512-SbKbANkN603Vi4jEZv49LeVJMn4yGwsbzZworEoyEiutsN3nJYdbO36zfhGJ6QEDpOZIFkDtnq5JRxmvl3jsoQ==", + "dev": true, "engines": { "node": ">=0.10.0" } @@ -1685,6 +1654,7 @@ "version": "3.0.0", "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-3.0.0.tgz", "integrity": "sha512-zymm5+u+sCsSWyD9qNaejV3DFvhCKclKdizYaJUuHA83RLjb7nSuGnddCHGv0hk+KY7BMAlsWeK4Ueg6EV6XQg==", + "dev": true, "engines": { "node": ">=8" } @@ -1693,6 +1663,7 @@ "version": "4.0.3", "resolved": "https://registry.npmjs.org/is-glob/-/is-glob-4.0.3.tgz", "integrity": "sha512-xelSayHH36ZgE7ZWhli7pW34hNbNl8Ojv5KVmkJD4hBdD3th8Tfk9vYasLM+mXWOZhFkgZfxhLSnrwRr4elSSg==", + "dev": true, "dependencies": { "is-extglob": "^2.1.1" }, @@ -1704,6 +1675,7 @@ "version": "7.0.0", "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true, "engines": { "node": ">=0.12.0" } @@ -1729,7 +1701,8 @@ "node_modules/js-tokens": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz", - "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==" + "integrity": "sha512-RdJUflcE3cUzKiMqQgsCu06FPu9UdIJO0beYbPhHN4k6apgJtifcoCtT9bcxOpYBtpD2kCM6Sbzg4CausW/PKQ==", + "dev": true }, "node_modules/js-yaml": { "version": "3.14.1", @@ -1747,7 +1720,8 @@ "node_modules/json-schema-traverse": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz", - "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==" + "integrity": "sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug==", + "dev": true }, "node_modules/jsonpath-plus": { "version": "6.0.1", @@ -1762,6 +1736,7 @@ "version": "3.0.3", "resolved": "https://registry.npmjs.org/kleur/-/kleur-3.0.3.tgz", "integrity": "sha512-eTIzlVOSUR+JxdDFepEYcBMtZ9Qqdef+rnzWdRZuMbOywu5tO2w2N7rqjoANZ5k9vywhL6Br1VRjUIgTQx4E8w==", + "dev": true, "engines": { "node": ">=6" } @@ -1782,6 +1757,7 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/lower-case/-/lower-case-2.0.2.tgz", "integrity": "sha512-7fm3l3NAF9WfN6W3JOmf5drwpVqX78JtoGJ3A6W0a6ZnldM41w2fV5D490psKFTpMds8TJse/eHLFFsNHHjHgg==", + "dev": true, "dependencies": { "tslib": "^2.0.3" } @@ -1798,12 +1774,6 @@ "node": ">=10" } }, - "node_modules/make-error": { - "version": "1.3.6", - "resolved": "https://registry.npmjs.org/make-error/-/make-error-1.3.6.tgz", - "integrity": "sha512-s8UhlNe7vPKomQhC1qFelMokr/Sc3AgNbso3n74mVPA5LTZwkB9NlXf4XPamLxJE8h0gh73rM94xvwRT2CVInw==", - "dev": true - }, "node_modules/mdurl": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", @@ -1814,6 +1784,7 @@ "version": "1.4.1", "resolved": "https://registry.npmjs.org/merge2/-/merge2-1.4.1.tgz", "integrity": "sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==", + "dev": true, "engines": { "node": ">= 8" } @@ -1822,6 +1793,7 @@ "version": "4.0.5", "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.5.tgz", "integrity": "sha512-DMy+ERcEW2q8Z2Po+WNXuw3c5YaUSFjAO5GsJqfEl7UjvtIuFKO6ZrKvcItdy98dwFI2N1tg3zNIdKaQT+aNdA==", + "dev": true, "dependencies": { "braces": "^3.0.2", "picomatch": "^2.3.1" @@ -1876,6 +1848,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", + "dev": true, "bin": { "mkdirp": "bin/cmd.js" }, @@ -1887,6 +1860,7 @@ "version": "4.2.0", "resolved": "https://registry.npmjs.org/mustache/-/mustache-4.2.0.tgz", "integrity": "sha512-71ippSywq5Yb7/tVYyGbkBggbU8H3u5Rz56fH60jGFgr8uHwxs+aSKeqmluIVzM0m0kB7xQjKS6qPfd0b2ZoqQ==", + "dev": true, "bin": { "mustache": "bin/mustache" } @@ -1895,6 +1869,7 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/no-case/-/no-case-3.0.4.tgz", "integrity": "sha512-fgAN3jGAh+RoxUGZHTSOLJIqUc2wmoBwGR4tbpNAKmmovFoWq0OdRkb0VkldReO2a2iBT/OEulG9XSUc10r3zg==", + "dev": true, "dependencies": { "lower-case": "^2.0.2", "tslib": "^2.0.3" @@ -1904,6 +1879,7 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz", "integrity": "sha512-/jKZoMpw0F8GRwl4/eLROPA3cfcXtLApP0QzLmUT/HuPCZWyB7IY9ZrMeKw2O/nFIqPQB3PVM9aYm0F312AXDQ==", + "dev": true, "funding": [ { "type": "github", @@ -1963,6 +1939,7 @@ "version": "0.7.3", "resolved": "https://registry.npmjs.org/node-watch/-/node-watch-0.7.3.tgz", "integrity": "sha512-3l4E8uMPY1HdMMryPRUAl+oIHtXtyiTlIiESNSVSNxcPfzAFzeTbXFQkZfAwBbo0B1qMSG8nUABx+Gd+YrbKrQ==", + "dev": true, "engines": { "node": ">=6" } @@ -2016,6 +1993,7 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/param-case/-/param-case-3.0.4.tgz", "integrity": "sha512-RXlj7zCYokReqWpOPH9oYivUzLYZ5vAPIfEmCTNViosC78F8F0H9y7T7gG2M39ymgutxF5gcFEsyZQSph9Bp3A==", + "dev": true, "dependencies": { "dot-case": "^3.0.4", "tslib": "^2.0.3" @@ -2025,6 +2003,7 @@ "version": "3.1.2", "resolved": "https://registry.npmjs.org/pascal-case/-/pascal-case-3.1.2.tgz", "integrity": "sha512-uWlGT3YSnK9x3BQJaOdcZwrnV6hPpd8jFH1/ucpiLRPh/2zCVJKS19E4GvYHvaCcACn3foXZ0cLB9Wrx1KGe5g==", + "dev": true, "dependencies": { "no-case": "^3.0.4", "tslib": "^2.0.3" @@ -2034,6 +2013,7 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/path-case/-/path-case-3.0.4.tgz", "integrity": "sha512-qO4qCFjXqVTrcbPt/hQfhTQ+VhFsqNKOPtytgNKkKxSoEp3XPUQ8ObFuePylOIok5gjn69ry8XiULxCwot3Wfg==", + "dev": true, "dependencies": { "dot-case": "^3.0.4", "tslib": "^2.0.3" @@ -2061,6 +2041,7 @@ "version": "4.0.0", "resolved": "https://registry.npmjs.org/path-type/-/path-type-4.0.0.tgz", "integrity": "sha512-gDKb8aZMDeD/tZWs9P6+q0J9Mwkdl6xMV8TjnGP3qJVJ06bdMgkbBlLU8IdfOsIsFz2BW1rNVT3XuNEl8zPAvw==", + "dev": true, "engines": { "node": ">=8" } @@ -2068,12 +2049,14 @@ "node_modules/picocolors": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.0.0.tgz", - "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==" + "integrity": "sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==", + "dev": true }, "node_modules/picomatch": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/picomatch/-/picomatch-2.3.1.tgz", "integrity": "sha512-JU3teHTNjmE2VCGFzuY8EXzCDVwEqB2a8fsIvwaStHhAWJEeVd1o1QD80CU6+ZdEXXSLbSsuLwJjkCBWqRQUVA==", + "dev": true, "engines": { "node": ">=8.6" }, @@ -2082,9 +2065,10 @@ } }, "node_modules/prettier": { - "version": "2.8.4", - "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.4.tgz", - "integrity": "sha512-vIS4Rlc2FNh0BySk3Wkd6xmwxB0FpOndW5fisM5H8hsZSxU2VWVB5CWIkIjWvrHjIhxk2g3bfMKM87zNTrZddw==", + "version": "2.8.8", + "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.8.8.tgz", + "integrity": "sha512-tdN8qQGvNjw4CHbY+XXk0JgCXn9QiF21a55rBe5LJAU+kDyC4WQn4+awm2Xfk2lQMk5fKup9XgzTZtGkjBdP9Q==", + "dev": true, "bin": { "prettier": "bin-prettier.js" }, @@ -2099,6 +2083,7 @@ "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", "integrity": "sha512-NxNv/kLguCA7p3jE8oL2aEBsrJWgAakBpgmgK6lpPWV+WuOmY6r2/zbAVnP+T8bQlA0nzHXSJSJW0Hq7ylaD2Q==", + "dev": true, "dependencies": { "kleur": "^3.0.3", "sisteransi": "^1.0.5" @@ -2111,6 +2096,7 @@ "version": "2.3.0", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.0.tgz", "integrity": "sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA==", + "dev": true, "engines": { "node": ">=6" } @@ -2119,6 +2105,7 @@ "version": "1.2.3", "resolved": "https://registry.npmjs.org/queue-microtask/-/queue-microtask-1.2.3.tgz", "integrity": "sha512-NuaNSa6flKT5JaSYQzJok04JzTL1CA6aGhv5rfLW3PgqA+M2ChpZQnAC8h8i4ZFkBS8X5RqkDBHA7r4hej3K9A==", + "dev": true, "funding": [ { "type": "github", @@ -2138,6 +2125,7 @@ "version": "2.1.1", "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", "integrity": "sha512-fGxEI7+wsG9xrvdjsrlmL22OMTTiHRwAMroiEeMgq8gzoLC/PQr7RsRDSTLUg/bZAZtF+TVIkHc6/4RIKrui+Q==", + "dev": true, "engines": { "node": ">=0.10.0" } @@ -2146,6 +2134,7 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/require-from-string/-/require-from-string-2.0.2.tgz", "integrity": "sha512-Xf0nWe6RseziFMu+Ap9biiUbmplq6S9/p+7w7YXP/JBHhrUDDUhwa+vANyubuqfZWTveU//DYVGsDG7RKL/vEw==", + "dev": true, "engines": { "node": ">=0.10.0" } @@ -2169,6 +2158,7 @@ "version": "1.0.4", "resolved": "https://registry.npmjs.org/reusify/-/reusify-1.0.4.tgz", "integrity": "sha512-U9nH88a3fc/ekCF1l0/UP1IosiuIjyTh7hBvXVMHYgVcfGvt897Xguj2UOLDeI5BG2m7/uwyaLVT6fbtCwTyzw==", + "dev": true, "engines": { "iojs": ">=1.0.0", "node": ">=0.10.0" @@ -2178,6 +2168,7 @@ "version": "1.2.0", "resolved": "https://registry.npmjs.org/run-parallel/-/run-parallel-1.2.0.tgz", "integrity": "sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==", + "dev": true, "funding": [ { "type": "github", @@ -2197,9 +2188,9 @@ } }, "node_modules/semver": { - "version": "7.3.8", - "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.8.tgz", - "integrity": "sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A==", + "version": "7.5.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.0.tgz", + "integrity": "sha512-+XC0AD/R7Q2mPSRuy2Id0+CGTZ98+8f+KvwirxOKIEyid+XSx6HbC63p+O4IndTHuX5Z+JxQ0TghCkO5Cg/2HA==", "dev": true, "dependencies": { "lru-cache": "^6.0.0" @@ -2215,6 +2206,7 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/sentence-case/-/sentence-case-3.0.4.tgz", "integrity": "sha512-8LS0JInaQMCRoQ7YUytAo/xUu5W2XnQxV2HI/6uM6U7CITS1RqPElr30V6uIqyMKM9lJGRVFy5/4CuzcixNYSg==", + "dev": true, "dependencies": { "no-case": "^3.0.4", "tslib": "^2.0.3", @@ -2236,12 +2228,14 @@ "node_modules/sisteransi": { "version": "1.0.5", "resolved": "https://registry.npmjs.org/sisteransi/-/sisteransi-1.0.5.tgz", - "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==" + "integrity": "sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==", + "dev": true }, "node_modules/slash": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/slash/-/slash-4.0.0.tgz", "integrity": "sha512-3dOsAHXXUkQTpOYcoAxLIorMTp4gIQr5IW3iVb7A7lFIp0VHhnynm9izx6TssdrIcVIESAlVjtnO2K8bg+Coew==", + "dev": true, "engines": { "node": ">=12" }, @@ -2253,6 +2247,7 @@ "version": "3.0.4", "resolved": "https://registry.npmjs.org/snake-case/-/snake-case-3.0.4.tgz", "integrity": "sha512-LAOh4z89bGQvl9pFfNF8V146i7o7/CqFPbqzYgP+yYzDIDeS9HaNFtXABamRW+AQzEVODcvE79ljJ+8a9YSdMg==", + "dev": true, "dependencies": { "dot-case": "^3.0.4", "tslib": "^2.0.3" @@ -2268,6 +2263,7 @@ "version": "4.2.3", "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.3.tgz", "integrity": "sha512-wKyQRQpjJ0sIp62ErSZdGsjMJWsap5oRNihHhu6G7JVO/9jIB6UyevL+tXuOqrng8j/cxKTWyWUwvSTriiZz/g==", + "dev": true, "dependencies": { "emoji-regex": "^8.0.0", "is-fullwidth-code-point": "^3.0.0", @@ -2287,6 +2283,7 @@ "version": "6.0.1", "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.1.tgz", "integrity": "sha512-Y38VPSHcqkFrCpFnQ9vuSXmquuv5oXOKpGeT6aGrr3o3Gc9AlVa6JBfUSOCnbxGGZF+/0ooI7KrPuUSztUdU5A==", + "dev": true, "dependencies": { "ansi-regex": "^5.0.1" }, @@ -2298,6 +2295,7 @@ "version": "5.5.0", "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz", "integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==", + "dev": true, "dependencies": { "has-flag": "^3.0.0" }, @@ -2309,6 +2307,7 @@ "version": "5.0.1", "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, "dependencies": { "is-number": "^7.0.0" }, @@ -2322,71 +2321,30 @@ "integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==", "dev": true }, - "node_modules/ts-node": { - "version": "10.9.1", - "resolved": "https://registry.npmjs.org/ts-node/-/ts-node-10.9.1.tgz", - "integrity": "sha512-NtVysVPkxxrwFGUUxGYhfux8k78pQB3JqYBXlLRZgdGUqTO5wU/UyHop5p70iEbGhB7q5KmiZiU0Y3KlJrScEw==", - "dev": true, - "dependencies": { - "@cspotcode/source-map-support": "^0.8.0", - "@tsconfig/node10": "^1.0.7", - "@tsconfig/node12": "^1.0.7", - "@tsconfig/node14": "^1.0.0", - "@tsconfig/node16": "^1.0.2", - "acorn": "^8.4.1", - "acorn-walk": "^8.1.1", - "arg": "^4.1.0", - "create-require": "^1.1.0", - "diff": "^4.0.1", - "make-error": "^1.1.1", - "v8-compile-cache-lib": "^3.0.1", - "yn": "3.1.1" - }, - "bin": { - "ts-node": "dist/bin.js", - "ts-node-cwd": "dist/bin-cwd.js", - "ts-node-esm": "dist/bin-esm.js", - "ts-node-script": "dist/bin-script.js", - "ts-node-transpile-only": "dist/bin-transpile.js", - "ts-script": "dist/bin-script-deprecated.js" - }, - "peerDependencies": { - "@swc/core": ">=1.2.50", - "@swc/wasm": ">=1.2.50", - "@types/node": "*", - "typescript": ">=2.7" - }, - "peerDependenciesMeta": { - "@swc/core": { - "optional": true - }, - "@swc/wasm": { - "optional": true - } - } - }, "node_modules/tslib": { "version": "2.5.0", "resolved": "https://registry.npmjs.org/tslib/-/tslib-2.5.0.tgz", - "integrity": "sha512-336iVw3rtn2BUK7ORdIAHTyxHGRIHVReokCR3XjbckJMK7ms8FysBfhLR8IXnAgy7T0PTPNBWKiH514FOW/WSg==" + "integrity": "sha512-336iVw3rtn2BUK7ORdIAHTyxHGRIHVReokCR3XjbckJMK7ms8FysBfhLR8IXnAgy7T0PTPNBWKiH514FOW/WSg==", + "dev": true }, "node_modules/typescript": { - "version": "3.9.10", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.9.10.tgz", - "integrity": "sha512-w6fIxVE/H1PkLKcCPsFqKE7Kv7QUwhU8qQY2MueZXWx5cPZdwFupLgKK3vntcK98BtNHZtAF4LA/yl2a7k8R6Q==", + "version": "5.0.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.0.4.tgz", + "integrity": "sha512-cW9T5W9xY37cc+jfEnaUvX91foxtHkza3Nw3wkoF4sSlKn0MONdkdEndig/qPBWXNkmplh3NzayQzCiHM4/hqw==", "dev": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" }, "engines": { - "node": ">=4.2.0" + "node": ">=12.20" } }, "node_modules/upper-case": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/upper-case/-/upper-case-2.0.2.tgz", "integrity": "sha512-KgdgDGJt2TpuwBUIjgG6lzw2GWFRCW9Qkfkiv0DxqHHLYJHmtmdUIKcZd8rHgFSjopVTlw6ggzCm1b8MFQwikg==", + "dev": true, "dependencies": { "tslib": "^2.0.3" } @@ -2395,6 +2353,7 @@ "version": "2.0.2", "resolved": "https://registry.npmjs.org/upper-case-first/-/upper-case-first-2.0.2.tgz", "integrity": "sha512-514ppYHBaKwfJRK/pNC6c/OxfGa0obSnAl106u97Ed0I625Nin96KAjttZF6ZL3e1XLtphxnqrOi9iWgm+u+bg==", + "dev": true, "dependencies": { "tslib": "^2.0.3" } @@ -2403,6 +2362,7 @@ "version": "4.4.1", "resolved": "https://registry.npmjs.org/uri-js/-/uri-js-4.4.1.tgz", "integrity": "sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg==", + "dev": true, "dependencies": { "punycode": "^2.1.0" } @@ -2416,16 +2376,11 @@ "uuid": "dist/bin/uuid" } }, - "node_modules/v8-compile-cache-lib": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/v8-compile-cache-lib/-/v8-compile-cache-lib-3.0.1.tgz", - "integrity": "sha512-wa7YjyUGfNZngI/vtK0UHAN+lgDCxBPCylVXGp0zu59Fz5aiGtNXaq3DhIov063MorB+VfufLh3JlF2KdTK3xg==", - "dev": true - }, "node_modules/vscode-jsonrpc": { "version": "8.0.2", "resolved": "https://registry.npmjs.org/vscode-jsonrpc/-/vscode-jsonrpc-8.0.2.tgz", "integrity": "sha512-RY7HwI/ydoC1Wwg4gJ3y6LpU9FJRZAUnTYMXthqhFXXu77ErDd/xkREpGuk4MyYkk4a+XDWAMqe0S3KkelYQEQ==", + "dev": true, "engines": { "node": ">=14.0.0" } @@ -2434,6 +2389,7 @@ "version": "8.0.2", "resolved": "https://registry.npmjs.org/vscode-languageserver/-/vscode-languageserver-8.0.2.tgz", "integrity": "sha512-bpEt2ggPxKzsAOZlXmCJ50bV7VrxwCS5BI4+egUmure/oI/t4OlFzi/YNtVvY24A2UDOZAgwFGgnZPwqSJubkA==", + "dev": true, "dependencies": { "vscode-languageserver-protocol": "3.17.2" }, @@ -2445,6 +2401,7 @@ "version": "3.17.2", "resolved": "https://registry.npmjs.org/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.17.2.tgz", "integrity": "sha512-8kYisQ3z/SQ2kyjlNeQxbkkTNmVFoQCqkmGrzLH6A9ecPlgTbp3wDTnUNqaUxYr4vlAcloxx8zwy7G5WdguYNg==", + "dev": true, "dependencies": { "vscode-jsonrpc": "8.0.2", "vscode-languageserver-types": "3.17.2" @@ -2453,17 +2410,20 @@ "node_modules/vscode-languageserver-textdocument": { "version": "1.0.8", "resolved": "https://registry.npmjs.org/vscode-languageserver-textdocument/-/vscode-languageserver-textdocument-1.0.8.tgz", - "integrity": "sha512-1bonkGqQs5/fxGT5UchTgjGVnfysL0O8v1AYMBjqTbWQTFn721zaPGDYFkOKtfDgFiSgXM3KwaG3FMGfW4Ed9Q==" + "integrity": "sha512-1bonkGqQs5/fxGT5UchTgjGVnfysL0O8v1AYMBjqTbWQTFn721zaPGDYFkOKtfDgFiSgXM3KwaG3FMGfW4Ed9Q==", + "dev": true }, "node_modules/vscode-languageserver-types": { "version": "3.17.2", "resolved": "https://registry.npmjs.org/vscode-languageserver-types/-/vscode-languageserver-types-3.17.2.tgz", - "integrity": "sha512-zHhCWatviizPIq9B7Vh9uvrH6x3sK8itC84HkamnBWoDFJtzBf7SWlpLCZUit72b3os45h6RWQNC9xHRDF8dRA==" + "integrity": "sha512-zHhCWatviizPIq9B7Vh9uvrH6x3sK8itC84HkamnBWoDFJtzBf7SWlpLCZUit72b3os45h6RWQNC9xHRDF8dRA==", + "dev": true }, "node_modules/web-streams-polyfill": { "version": "3.2.1", "resolved": "https://registry.npmjs.org/web-streams-polyfill/-/web-streams-polyfill-3.2.1.tgz", "integrity": "sha512-e0MO3wdXWKrLbL0DgGnUV7WHVuw9OUvL4hjgnPkIeEvESk74gAITi5G606JtZPp39cd8HA9VQzCIvA49LpPN5Q==", + "dev": true, "engines": { "node": ">= 8" } @@ -2500,9 +2460,9 @@ } }, "node_modules/which-module": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", - "integrity": "sha512-B+enWhmw6cjfVC7kS8Pj9pCrKSc5txArRyaYGe088shv/FGWH+0Rjx/xPgtsWfsUtS27FkP697E4DDhgrgoc0Q==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.1.tgz", + "integrity": "sha512-iBdZ57RDvnOR9AGBhML2vFZf7h8vmBjhoaZqODJBFWHVtKkDmKuHai3cx5PgVMrX5YDNp27AofYbAwctSS+vhQ==", "dev": true }, "node_modules/wrap-ansi": { @@ -2604,15 +2564,6 @@ "engines": { "node": ">=6" } - }, - "node_modules/yn": { - "version": "3.1.1", - "resolved": "https://registry.npmjs.org/yn/-/yn-3.1.1.tgz", - "integrity": "sha512-Ux4ygGWsu2c7isFWe8Yu1YluJmqVhxqK2cLXNQA5AcC3QfbGNpM7fu0Y8b/z16pXLnFxZYvWhd3fhBY9DLmC6Q==", - "dev": true, - "engines": { - "node": ">=6" - } } } } diff --git a/package.json b/package.json index 7cdb7bab6fc6..01c1ebce5241 100644 --- a/package.json +++ b/package.json @@ -1,28 +1,24 @@ { "name": "azure-rest-api-specs", - "dependencies": { + "devDependencies": { + "@azure-tools/cadl-apiview": "0.3.5", "@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-apiview": "0.3.5", + "@azure-tools/typespec-apiview": "0.4.4", "@azure-tools/typespec-autorest": "0.29.0", "@azure-tools/typespec-azure-core": "0.29.0", "@azure-tools/typespec-azure-resource-manager": "0.29.0", "@azure-tools/typespec-providerhub": "0.29.0", - "@azure-tools/typespec-apiview": "0.4.4", - "@typespec/compiler": "0.43.0" - }, - "devDependencies": { + "@typespec/compiler": "0.43.0", "@azure/avocado": "^0.8.4", - "@types/prettier": "^2.6.1", - "prettier": "^2.7.1", - "ts-node": "^10.1.0", - "typescript": "^3.5.3" + "@types/prettier": "^2.7.2", + "prettier": "^2.8.8", + "typescript": "~5.0.4" }, "scripts": { - "prettier-check": "ts-node ./scripts/prettier-check.ts", - "prettier-fix": "prettier --write specification/**/*.json" + "postinstall": "tsc" }, "private": true } diff --git a/scripts/prettier-check.ts b/scripts/prettier-check.ts deleted file mode 100644 index 0f2e461649fd..000000000000 --- a/scripts/prettier-check.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { runCheckOverChangedSpecFiles, logWarn, logError } from "./utils"; - -runCheckOverChangedSpecFiles({ - onCheckFile: (context, filePath) => { - return context.exec(`prettier -c ${filePath}`); - }, - - onExecError: async (result) => { - if (result.stdout) { - console.log(result.stdout); - } - }, - - onNotInCI: (context) => { - logWarn("Not in CI environment. Run against all the spec json."); - return context.exec(`prettier -c "specification/**/*.json"`); - }, - - onFinalFailed: async () => { - logError('Code style issues found in the above file(s). Please follow https://aka.ms/AA6h31t to fix the issue.') - } -}) \ No newline at end of file diff --git a/scripts/utils.ts b/scripts/utils.ts deleted file mode 100644 index 3ffddc3d736a..000000000000 --- a/scripts/utils.ts +++ /dev/null @@ -1,81 +0,0 @@ -import { ExecOptions } from 'child_process'; -import { childProcess, cli, devOps } from '@azure/avocado'; - -export const logToAzureDevops = (msg: string, type: string) => { - const lines = msg.split('\n'); - for (const line of lines) { - console.log(`##vso[task.logissue type=${type}]${line}`); - } -} - -export const logError = (msg: string) => logToAzureDevops(msg, 'error'); -export const logWarn = (msg: string) => logToAzureDevops(msg, 'warning'); - -export type Exec = (commandLine: string, options?: ExecOptions) => Promise; -export type CheckContext = { - exec: Exec; -}; -export type CheckOptions = { - onExecError(result: childProcess.ExecResult): Promise; - onNotInCI(context: CheckContext): Promise; - onCheckFile(context: CheckContext, filePath: string): Promise; - onFinalFailed(context: CheckContext): Promise; -} - -const internalCheck = async (checkOptions: CheckOptions) => { - - const exec = async (commandLine: string, options: ExecOptions = {}) => { - console.log(commandLine); - let result: any = {}; - try { - result = await childProcess.exec(commandLine, options); - } catch (e) { - result = e; - } - - if (!result.code) { - return 0; - } - await checkOptions.onExecError(result); - - return result.code; - } - const context: CheckContext = { exec }; - - const config = cli.defaultConfig(); - const pr = await devOps.createPullRequestProperties(config); - if (pr === undefined) { - return checkOptions.onNotInCI(context); - } - - const changedJsonFiles = (await pr.diff()) - .filter(change => change.kind !== 'Deleted') - .map(change => change.path) - .filter(filePath => filePath.endsWith('.json') && filePath.startsWith('specification/')); - if (changedJsonFiles.length === 0) { - logWarn("No changed spec json file"); - return; - } - - let retCode = 0; - for (const jsonFile of changedJsonFiles) { - const code = await checkOptions.onCheckFile(context, jsonFile); - if (code !== 0) { - retCode = code; - } - } - - if (retCode !== 0) { - await checkOptions.onFinalFailed(context); - } - - process.exit(retCode); -} - -export const runCheckOverChangedSpecFiles = (options: CheckOptions) => { - internalCheck(options).catch(e => { - console.error(e); - logError(`Fatal Error. Please report to adxsr@microsoft.com`); - process.exit(-1); - }); -} diff --git a/specification/eventgrid/data-plane/Microsoft.AppConfiguration/stable/2018-01-01/examples/cloud-events-schema/keyvalue_deleted.json b/specification/eventgrid/data-plane/Microsoft.AppConfiguration/stable/2018-01-01/examples/cloud-events-schema/keyvalue_deleted.json index d2ad99ad5a9e..651e1e679d83 100644 --- a/specification/eventgrid/data-plane/Microsoft.AppConfiguration/stable/2018-01-01/examples/cloud-events-schema/keyvalue_deleted.json +++ b/specification/eventgrid/data-plane/Microsoft.AppConfiguration/stable/2018-01-01/examples/cloud-events-schema/keyvalue_deleted.json @@ -11,4 +11,4 @@ "syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.AppConfiguration/stable/2018-01-01/examples/cloud-events-schema/keyvalue_modified.json b/specification/eventgrid/data-plane/Microsoft.AppConfiguration/stable/2018-01-01/examples/cloud-events-schema/keyvalue_modified.json index 1d7e12a9368c..fe075aac3753 100644 --- a/specification/eventgrid/data-plane/Microsoft.AppConfiguration/stable/2018-01-01/examples/cloud-events-schema/keyvalue_modified.json +++ b/specification/eventgrid/data-plane/Microsoft.AppConfiguration/stable/2018-01-01/examples/cloud-events-schema/keyvalue_modified.json @@ -11,4 +11,4 @@ "syncToken": "zAJw6V16=Njo1IzUxNjQ2NzM=;sn=5164673" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/export_rdb_completed.json b/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/export_rdb_completed.json index dc4dc52ba26f..7084ee3cafba 100644 --- a/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/export_rdb_completed.json +++ b/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/export_rdb_completed.json @@ -10,4 +10,4 @@ "status": "Succeeded" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/import_rdb_completed.json b/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/import_rdb_completed.json index c0510aee75cc..73b195138cc2 100644 --- a/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/import_rdb_completed.json +++ b/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/import_rdb_completed.json @@ -10,4 +10,4 @@ "status": "Succeeded" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/patching_completed.json b/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/patching_completed.json index c8b8fa2ae0ac..10d89b82c0d2 100644 --- a/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/patching_completed.json +++ b/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/patching_completed.json @@ -10,4 +10,4 @@ "status": "Succeeded" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/scaling_completed.json b/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/scaling_completed.json index 2c9b84af999b..e3fa3a25c54f 100644 --- a/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/scaling_completed.json +++ b/specification/eventgrid/data-plane/Microsoft.Cache/stable/2018-01-01/examples/cloud-events-schema/scaling_completed.json @@ -10,4 +10,4 @@ "status": "Succeeded" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_deleted_in_thread.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_deleted_in_thread.json index 83650614a143..bda48a25de3a 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_deleted_in_thread.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_deleted_in_thread.json @@ -21,4 +21,4 @@ "transactionId": "HqU6PeK5AkCRSpW8eAbL0A.1.1.2.1.987824181.1" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_edited.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_edited.json index 6f969c1d5bcd..663c02f47271 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_edited.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_edited.json @@ -34,4 +34,4 @@ "threadId": "19:6e5d6ca1d75044a49a36a7965ec4a906@thread.v2" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_edited_in_thread.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_edited_in_thread.json index 7d0f79f8e4eb..47cb29acaef9 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_edited_in_thread.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_edited_in_thread.json @@ -26,4 +26,4 @@ "transactionId": "H8Gpj3NkIU6bXlWw8WPvhQ.2.1.2.1.985333801.1" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_received.json index 2aa2b9399407..48b607bec9f8 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_received.json @@ -33,4 +33,4 @@ "threadId": "19:6e5d6ca1d75044a49a36a7965ec4a906@thread.v2" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_received_in_thread.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_received_in_thread.json index 1b8ec17dc1e1..651387c26394 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_received_in_thread.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_message_received_in_thread.json @@ -25,4 +25,4 @@ "transactionId": "foMkntkKS0O/MhMlIE5Aag.1.1.1.1.1004077250.1" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_added_to_thread_with_user.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_added_to_thread_with_user.json index 1721f4764975..87bd21043d23 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_added_to_thread_with_user.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_added_to_thread_with_user.json @@ -33,4 +33,4 @@ "threadId": "19:f1400e1c542f4086a606b52ad20cd0bd@thread.v2" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_removed_from_thread_with_user.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_removed_from_thread_with_user.json index a2db1c0967d5..84f6c7ab7de6 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_removed_from_thread_with_user.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_participant_removed_from_thread_with_user.json @@ -33,4 +33,4 @@ "threadId": "19:f1400e1c542f4086a606b52ad20cd0bd@thread.v2" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created.json index 4f265453c17d..a6c88fa80bf2 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created.json @@ -58,4 +58,4 @@ "transactionId": "gK6+kgANy0O1wchlVKVTJg.1.1.1.1.921436178.1" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created_withUser.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created_withUser.json index a0b3986a98b6..c7f2175a8f1b 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created_withUser.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_created_withUser.json @@ -58,4 +58,4 @@ "threadId": "19:1d594fb1eeb14566903cbc5decb5bf5b@thread.v2" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_deleted.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_deleted.json index 12be461ff243..ebf8dba57717 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_deleted.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_deleted.json @@ -18,4 +18,4 @@ "transactionId": "KibptDpcLEeEFnlR7cI3QA.1.1.2.1.848298005.1" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_added.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_added.json index 81874309a792..2bdd3f896269 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_added.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_added.json @@ -27,4 +27,4 @@ "transactionId": "9q6cO7i4FkaZ+5RRVzshVw.1.1.1.1.974913783.1" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_removed.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_removed.json index 53ef1e189a3c..0b375f8ed7c1 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_removed.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_participant_removed.json @@ -27,4 +27,4 @@ "transactionId": "zGCq8IGRr0aEF6COuy7wSA.1.1.1.1.978649284.1" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_properties_updated.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_properties_updated.json index bfdc733866b2..a2c4912aeec3 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_properties_updated.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_properties_updated.json @@ -21,4 +21,4 @@ "transactionId": "GBE9MB2a40KEWzexIg0D3A.1.1.1.1.856359041.1" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_properties_updated_per_user.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_properties_updated_per_user.json index c1b3106f0782..ef1d1ef51232 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_properties_updated_per_user.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_properties_updated_per_user.json @@ -29,4 +29,4 @@ "threadId": "19:2cc3504c41244d7483208a4f58a1f188@thread.v2" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_with_user_deleted.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_with_user_deleted.json index f0b3eccc47d2..0960638e0503 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_with_user_deleted.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/chat_thread_with_user_deleted.json @@ -26,4 +26,4 @@ "threadId": "19:5870b8f021d74fd786bf5aeb095da291@thread.v2" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/recording_file_status_updated.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/recording_file_status_updated.json index 5416920b51ce..de37f6f5c391 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/recording_file_status_updated.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/recording_file_status_updated.json @@ -25,4 +25,4 @@ "recordingFormatType": "Mp3" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/sms_delivery_report_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/sms_delivery_report_received.json index 98ce4a6836d5..79986d70a741 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/sms_delivery_report_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/sms_delivery_report_received.json @@ -20,4 +20,4 @@ ] }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/sms_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/sms_received.json index 2323850b5e6e..c21b90c2e58b 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/sms_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/sms_received.json @@ -12,4 +12,4 @@ "ReceivedTimestamp": "2020-09-18T00:27:45.32Z" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/user_disconnected.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/user_disconnected.json index 9d435f1fcc46..6a4b77fe8423 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/user_disconnected.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/user_disconnected.json @@ -13,4 +13,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/sms_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/sms_received.json index f75e062e2f43..cd1924f74fa2 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/sms_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/sms_received.json @@ -13,4 +13,4 @@ "dataVersion": "1.0", "metadataVersion": "1", "eventTime": "2020-09-18T00:27:47Z" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/chart_deleted.json b/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/chart_deleted.json index 4f611c7cc7a2..182a98f92377 100644 --- a/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/chart_deleted.json +++ b/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/chart_deleted.json @@ -23,4 +23,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/chart_pushed.json b/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/chart_pushed.json index 75ce868aed46..ead6f41720fb 100644 --- a/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/chart_pushed.json +++ b/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/chart_pushed.json @@ -23,4 +23,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/image_deleted.json b/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/image_deleted.json index 94507f70836a..337b68a11bfd 100644 --- a/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/image_deleted.json +++ b/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/image_deleted.json @@ -25,4 +25,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/image_pushed.json b/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/image_pushed.json index 2cf4c95878ef..35ab208a394b 100644 --- a/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/image_pushed.json +++ b/specification/eventgrid/data-plane/Microsoft.ContainerRegistry/stable/2018-01-01/examples/cloud-events-schema/image_pushed.json @@ -28,4 +28,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.ContainerService/stable/2018-01-01/examples/cloud-events-schema/new_kubernetes_version_available.json b/specification/eventgrid/data-plane/Microsoft.ContainerService/stable/2018-01-01/examples/cloud-events-schema/new_kubernetes_version_available.json index 6ec4dc7cb0a0..3a7a31538931 100644 --- a/specification/eventgrid/data-plane/Microsoft.ContainerService/stable/2018-01-01/examples/cloud-events-schema/new_kubernetes_version_available.json +++ b/specification/eventgrid/data-plane/Microsoft.ContainerService/stable/2018-01-01/examples/cloud-events-schema/new_kubernetes_version_available.json @@ -11,4 +11,4 @@ "latestPreviewKubernetesVersion": "1.21.1" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_connected.json b/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_connected.json index 55b4e8bb21b7..b437643b37ab 100644 --- a/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_connected.json +++ b/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_connected.json @@ -13,4 +13,4 @@ "moduleId": "DeviceModuleID" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_created.json b/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_created.json index 1c564fd3fc0b..49d4f1cdb219 100644 --- a/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_created.json +++ b/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_created.json @@ -39,4 +39,4 @@ "deviceId": "LogicAppTestDevice" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_telemetry.json b/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_telemetry.json index 07377d22d8e4..89ea86765493 100644 --- a/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_telemetry.json +++ b/specification/eventgrid/data-plane/Microsoft.Devices/stable/2018-01-01/examples/cloud-events-schema/device_telemetry.json @@ -25,4 +25,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json index 8d3a7f025a11..a34c66549942 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json +++ b/specification/eventgrid/data-plane/Microsoft.EventGrid/stable/2018-01-01/EventGrid.json @@ -29,8 +29,7 @@ "produces": [ "application/json" ], - "paths": { - }, + "paths": {}, "x-ms-paths": { "?overload=EventGridEvent": { "post": { diff --git a/specification/eventgrid/data-plane/Microsoft.EventHub/stable/2018-01-01/examples/cloud-events-schema/capture_file_created.json b/specification/eventgrid/data-plane/Microsoft.EventHub/stable/2018-01-01/examples/cloud-events-schema/capture_file_created.json index 68cd6108d4cb..36608a7ddf74 100644 --- a/specification/eventgrid/data-plane/Microsoft.EventHub/stable/2018-01-01/examples/cloud-events-schema/capture_file_created.json +++ b/specification/eventgrid/data-plane/Microsoft.EventHub/stable/2018-01-01/examples/cloud-events-schema/capture_file_created.json @@ -16,4 +16,4 @@ "lastEnqueueTime": "2017-08-31T19:12:44.309Z" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.KeyVault/stable/2018-01-01/examples/cloud-events-schema/secret_new_version_created.json b/specification/eventgrid/data-plane/Microsoft.KeyVault/stable/2018-01-01/examples/cloud-events-schema/secret_new_version_created.json index 482292945063..75bf647feb13 100644 --- a/specification/eventgrid/data-plane/Microsoft.KeyVault/stable/2018-01-01/examples/cloud-events-schema/secret_new_version_created.json +++ b/specification/eventgrid/data-plane/Microsoft.KeyVault/stable/2018-01-01/examples/cloud-events-schema/secret_new_version_created.json @@ -14,4 +14,4 @@ "EXP": "1559082102" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/dataset_drift_detected.json b/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/dataset_drift_detected.json index e4df875d6c17..892bac4d196b 100644 --- a/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/dataset_drift_detected.json +++ b/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/dataset_drift_detected.json @@ -15,4 +15,4 @@ "EndTime": "2019-07-04T17:00:00-07:00" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/model_deployed.json b/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/model_deployed.json index 1ed87704ed9a..89db7f3894a9 100644 --- a/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/model_deployed.json +++ b/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/model_deployed.json @@ -17,4 +17,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/model_registered.json b/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/model_registered.json index 1fc1489f7499..7cc7b75f8f06 100644 --- a/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/model_registered.json +++ b/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/model_registered.json @@ -16,4 +16,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/run_completed.json b/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/run_completed.json index 5ff82cda7288..62ffeb1a3c29 100644 --- a/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/run_completed.json +++ b/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/run_completed.json @@ -27,4 +27,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/run_status_changed.json b/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/run_status_changed.json index 1951febad1c6..c4dc319a4bc3 100644 --- a/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/run_status_changed.json +++ b/specification/eventgrid/data-plane/Microsoft.MachineLearningServices/stable/2018-01-01/examples/cloud-events-schema/run_status_changed.json @@ -28,4 +28,4 @@ "runStatus": "failed" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/examples/cloud-events-schema/geofence_entered.json b/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/examples/cloud-events-schema/geofence_entered.json index 1de4244f29ac..7a1638164063 100644 --- a/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/examples/cloud-events-schema/geofence_entered.json +++ b/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/examples/cloud-events-schema/geofence_entered.json @@ -19,4 +19,4 @@ "invalidPeriodGeofenceGeometryId": [] }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/examples/cloud-events-schema/geofence_result.json b/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/examples/cloud-events-schema/geofence_result.json index b65bc85cc04d..d0d45f513959 100644 --- a/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/examples/cloud-events-schema/geofence_result.json +++ b/specification/eventgrid/data-plane/Microsoft.Maps/stable/2018-01-01/examples/cloud-events-schema/geofence_result.json @@ -27,4 +27,4 @@ "invalidPeriodGeofenceGeometryId": [] }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/examples/cloud-events-schema/MediaLiveEventChannelArchiveHeartbeatEvent.json b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/examples/cloud-events-schema/MediaLiveEventChannelArchiveHeartbeatEvent.json index d51e6d83a07b..28a4884e4069 100644 --- a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/examples/cloud-events-schema/MediaLiveEventChannelArchiveHeartbeatEvent.json +++ b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/examples/cloud-events-schema/MediaLiveEventChannelArchiveHeartbeatEvent.json @@ -11,4 +11,4 @@ }, "specversion": "1.0" } -] \ No newline at end of file +] diff --git a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/examples/cloud-events-schema/MediaLiveEventIngestHeartbeatEvent.json b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/examples/cloud-events-schema/MediaLiveEventIngestHeartbeatEvent.json index 3bfea520cb65..5899706b5ed2 100644 --- a/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/examples/cloud-events-schema/MediaLiveEventIngestHeartbeatEvent.json +++ b/specification/eventgrid/data-plane/Microsoft.Media/stable/2018-01-01/examples/cloud-events-schema/MediaLiveEventIngestHeartbeatEvent.json @@ -25,4 +25,4 @@ }, "specversion": "1.0" } -] \ No newline at end of file +] diff --git a/specification/eventgrid/data-plane/Microsoft.PolicyInsights/stable/2018-01-01/examples/cloud-events-schema/policy_state_changed.json b/specification/eventgrid/data-plane/Microsoft.PolicyInsights/stable/2018-01-01/examples/cloud-events-schema/policy_state_changed.json index a05eb86d3872..d23ec5942072 100644 --- a/specification/eventgrid/data-plane/Microsoft.PolicyInsights/stable/2018-01-01/examples/cloud-events-schema/policy_state_changed.json +++ b/specification/eventgrid/data-plane/Microsoft.PolicyInsights/stable/2018-01-01/examples/cloud-events-schema/policy_state_changed.json @@ -14,4 +14,4 @@ "complianceReasonCode": "" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.PolicyInsights/stable/2018-01-01/examples/cloud-events-schema/policy_state_created.json b/specification/eventgrid/data-plane/Microsoft.PolicyInsights/stable/2018-01-01/examples/cloud-events-schema/policy_state_created.json index b18f4844fd95..a536768528a0 100644 --- a/specification/eventgrid/data-plane/Microsoft.PolicyInsights/stable/2018-01-01/examples/cloud-events-schema/policy_state_created.json +++ b/specification/eventgrid/data-plane/Microsoft.PolicyInsights/stable/2018-01-01/examples/cloud-events-schema/policy_state_created.json @@ -14,4 +14,4 @@ "complianceReasonCode": "" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_cancel.json b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_cancel.json index 6e5ee69d07d2..0d3adc12b401 100644 --- a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_cancel.json +++ b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_cancel.json @@ -48,4 +48,4 @@ "tenantId": "{tenant-id}" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_failure.json b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_failure.json index afa220366de6..beb1f4a26deb 100644 --- a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_failure.json +++ b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_failure.json @@ -48,4 +48,4 @@ "tenantId": "{tenant-id}" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_success.json b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_success.json index d110d06d653d..83c21386b265 100644 --- a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_success.json +++ b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_action_success.json @@ -48,4 +48,4 @@ "tenantId": "{tenant-id}" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_cancel.json b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_cancel.json index e0b9df0f80c1..98991497d670 100644 --- a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_cancel.json +++ b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_cancel.json @@ -57,4 +57,4 @@ "tenantId": "{tenant-id}" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_failure.json b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_failure.json index fb392479a92a..6e0bf2db7717 100644 --- a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_failure.json +++ b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_failure.json @@ -57,4 +57,4 @@ "tenantId": "{tenant-id}" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_success.json b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_success.json index 3eb39be8a4f9..fb85ff32b7dc 100644 --- a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_success.json +++ b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_delete_success.json @@ -57,4 +57,4 @@ "tenantId": "{tenant-id}" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_cancel.json b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_cancel.json index 1b91b564891d..699610f70e5e 100644 --- a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_cancel.json +++ b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_cancel.json @@ -51,4 +51,4 @@ "tenantId": "{tenant-id}" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_failure.json b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_failure.json index 6d6517dbf74b..a57beca433e5 100644 --- a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_failure.json +++ b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_failure.json @@ -51,4 +51,4 @@ "tenantId": "{tenant-id}" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_success.json b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_success.json index 19752d371889..d44ed045157a 100644 --- a/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_success.json +++ b/specification/eventgrid/data-plane/Microsoft.Resources/stable/2018-01-01/examples/cloud-events-schema/resource_write_success.json @@ -51,4 +51,4 @@ "tenantId": "{tenant-id}" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/active_messages_available_periodic_notifications.json b/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/active_messages_available_periodic_notifications.json index 92b5d9a6954a..688cb3856b28 100644 --- a/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/active_messages_available_periodic_notifications.json +++ b/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/active_messages_available_periodic_notifications.json @@ -13,4 +13,4 @@ "subscriptionName": "{subscription}" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/active_messages_available_with_no_listeners.json b/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/active_messages_available_with_no_listeners.json index 427113c3e0f9..d85bf1c2538e 100644 --- a/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/active_messages_available_with_no_listeners.json +++ b/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/active_messages_available_with_no_listeners.json @@ -13,4 +13,4 @@ "subscriptionName": null }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/deadletter_messages_available_periodic_notification.json b/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/deadletter_messages_available_periodic_notification.json index a311be7502c8..fb8b4680bde7 100644 --- a/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/deadletter_messages_available_periodic_notification.json +++ b/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/deadletter_messages_available_periodic_notification.json @@ -13,4 +13,4 @@ "subscriptionName": null }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/deadletter_messages_available_with_no_listeners.json b/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/deadletter_messages_available_with_no_listeners.json index 8d8bd28578da..f15eedd146d6 100644 --- a/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/deadletter_messages_available_with_no_listeners.json +++ b/specification/eventgrid/data-plane/Microsoft.ServiceBus/stable/2018-01-01/examples/cloud-events-schema/deadletter_messages_available_with_no_listeners.json @@ -13,4 +13,4 @@ "subscriptionName": "SUBSCRIPTION NAME" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.SignalRService/stable/2018-01-01/examples/cloud-events-schema/client_connection_connected.json b/specification/eventgrid/data-plane/Microsoft.SignalRService/stable/2018-01-01/examples/cloud-events-schema/client_connection_connected.json index 7f3f40b88a86..58be1ee5ad59 100644 --- a/specification/eventgrid/data-plane/Microsoft.SignalRService/stable/2018-01-01/examples/cloud-events-schema/client_connection_connected.json +++ b/specification/eventgrid/data-plane/Microsoft.SignalRService/stable/2018-01-01/examples/cloud-events-schema/client_connection_connected.json @@ -11,4 +11,4 @@ "userId": "user-eymwyo23" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.SignalRService/stable/2018-01-01/examples/cloud-events-schema/client_connection_disconnected.json b/specification/eventgrid/data-plane/Microsoft.SignalRService/stable/2018-01-01/examples/cloud-events-schema/client_connection_disconnected.json index 1ab293e02aef..6a71f400eeab 100644 --- a/specification/eventgrid/data-plane/Microsoft.SignalRService/stable/2018-01-01/examples/cloud-events-schema/client_connection_disconnected.json +++ b/specification/eventgrid/data-plane/Microsoft.SignalRService/stable/2018-01-01/examples/cloud-events-schema/client_connection_disconnected.json @@ -12,4 +12,4 @@ "errorMessage": "Internal server error." }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_created.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_created.json index f624a24a0b97..42286da3a36b 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_created.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_created.json @@ -19,4 +19,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_deleted.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_deleted.json index 8b40fca4f62c..2eb276f3df19 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_deleted.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_deleted.json @@ -18,4 +18,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_inventory_policy_completed.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_inventory_policy_completed.json index 6ba7493c1ad3..6e9302a6e89b 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_inventory_policy_completed.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_inventory_policy_completed.json @@ -14,4 +14,4 @@ "manifestBlobUrl": "https://jolovstorage.blob.core.windows.net/gaoaugcontainer/2021/08/20/22-04-55/gao8.20/gao8.20-manifest.json" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_renamed.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_renamed.json index f7cf4bcec5bf..98258333f3fb 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_renamed.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_renamed.json @@ -17,4 +17,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_tier_changed.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_tier_changed.json index 15edf4d850b8..f068456efd4f 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_tier_changed.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/blob_tier_changed.json @@ -18,4 +18,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_created.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_created.json index 094377131771..a0f731ca8b93 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_created.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_created.json @@ -28,4 +28,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_deleted.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_deleted.json index 51faf4950cd3..21244147be72 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_deleted.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_deleted.json @@ -16,4 +16,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_renamed.json b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_renamed.json index 1f2fe336907e..e54e577caeb4 100644 --- a/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_renamed.json +++ b/specification/eventgrid/data-plane/Microsoft.Storage/stable/2018-01-01/examples/cloud-events-schema/directory_renamed.json @@ -17,4 +17,4 @@ } }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_service_plan_updated.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_service_plan_updated.json index 0484f04ba456..e786622e247a 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_service_plan_updated.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_service_plan_updated.json @@ -25,4 +25,4 @@ "verb": "PUT" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_changed_app_settings.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_changed_app_settings.json index 3e90cab73a41..d5f4fd716fed 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_changed_app_settings.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_changed_app_settings.json @@ -16,4 +16,4 @@ "verb": "POST" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_restarted.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_restarted.json index 3e90cab73a41..d5f4fd716fed 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_restarted.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_restarted.json @@ -16,4 +16,4 @@ "verb": "POST" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_stopped.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_stopped.json index 3e90cab73a41..d5f4fd716fed 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_stopped.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/app_updated_stopped.json @@ -16,4 +16,4 @@ "verb": "POST" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_completed.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_completed.json index c5fe9b235987..9bb821ff381e 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_completed.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_completed.json @@ -16,4 +16,4 @@ "verb": "None" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_failed.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_failed.json index 85df06029f65..c46aa00b5597 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_failed.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_failed.json @@ -16,4 +16,4 @@ "verb": "None" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_started.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_started.json index 2f9de4f5bb04..53e9d9340a11 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_started.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/backup_operation_started.json @@ -16,4 +16,4 @@ "verb": "None" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_completed.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_completed.json index a08b06d02d43..33f9e2910064 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_completed.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_completed.json @@ -16,4 +16,4 @@ "verb": "POST" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_failed.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_failed.json index 180dbac95031..0e1ad6ed5a25 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_failed.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_failed.json @@ -16,4 +16,4 @@ "verb": "POST" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_started.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_started.json index 9e2f8b8acb3f..7170b205911d 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_started.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/restore_operation_started.json @@ -16,4 +16,4 @@ "verb": "POST" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_completed.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_completed.json index f4141a02e864..9fc95adce703 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_completed.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_completed.json @@ -16,4 +16,4 @@ "targetSlot": "production" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_failed.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_failed.json index f489a6182843..92b55e443a40 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_failed.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_failed.json @@ -16,4 +16,4 @@ "targetSlot": "production" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_started.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_started.json index db68e9b98440..d3c116310d9c 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_started.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_started.json @@ -16,4 +16,4 @@ "targetSlot": "production" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_with_preview_cancelled.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_with_preview_cancelled.json index daf6ef1bb6af..7b846d2c9c89 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_with_preview_cancelled.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_with_preview_cancelled.json @@ -16,4 +16,4 @@ "targetSlot": "production" }, "specversion": "1.0" -} \ No newline at end of file +} diff --git a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_with_preview_started.json b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_with_preview_started.json index eac029d41ef9..6e0908a9e1fd 100644 --- a/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_with_preview_started.json +++ b/specification/eventgrid/data-plane/Microsoft.Web/stable/2018-01-01/examples/cloud-events-schema/slot_swap_with_preview_started.json @@ -16,4 +16,4 @@ "targetSlot": "production" }, "specversion": "1.0" -} \ No newline at end of file +} From 7cd9fd824fbcb3f4ce0c778bfc427e285e98ec8e Mon Sep 17 00:00:00 2001 From: Ralf Beckers Date: Tue, 2 May 2023 18:29:11 +0200 Subject: [PATCH 03/79] Add 2023-05-15 api version for OpenAI (#23784) --- .../AzureOpenAI/authoring/readme.md | 22 +- .../stable/2023-05-15/azureopenai.json | 1508 +++++++++++++++++ .../2023-05-15/examples/cancel_finetune.json | 63 + .../2023-05-15/examples/delete_file.json | 13 + .../2023-05-15/examples/delete_finetune.json | 13 + .../stable/2023-05-15/examples/get_file.json | 27 + .../2023-05-15/examples/get_file_content.json | 14 + .../stable/2023-05-15/examples/get_files.json | 37 + .../2023-05-15/examples/get_finetune.json | 76 + .../examples/get_finetune_events.json | 36 + .../2023-05-15/examples/get_finetunes.json | 80 + .../2023-05-15/examples/get_model_base.json | 32 + .../examples/get_model_finetune.json | 33 + .../2023-05-15/examples/get_models.json | 56 + .../2023-05-15/examples/import_file.json | 29 + .../post_classification_finetune.json | 53 + .../2023-05-15/examples/post_finetune.json | 49 + .../2023-05-15/examples/upload_file.json | 26 + .../stable/2023-05-15/inference.json | 816 +++++++++ 19 files changed, 2982 insertions(+), 1 deletion(-) create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/azureopenai.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/cancel_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/delete_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/delete_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_file_content.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_files.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetune_events.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetunes.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_model_base.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_model_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_models.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/import_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/post_classification_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/post_finetune.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/upload_file.json create mode 100644 specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/inference.json diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md index 963fd25593ba..8500ca5664b7 100644 --- a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md @@ -4,7 +4,7 @@ Configuration for generating AzureOpenAI SDK. -The current release for the AzureOpenAI is `release_2022_12_01`. +The current release for the AzureOpenAI is `release_2023_05_15`. ``` yaml tag: release_2022_12_01 @@ -85,3 +85,23 @@ directive: - suppress: IntegerTypeMustHaveFormat reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. ``` + +## AzureOpenAI 2023-05-15 +These settings apply only when `--tag=release_2023_05_15` is specified on the command line. + +``` yaml $(tag) == 'release_2023_05_15' +input-file: stable/2023-05-15/azureopenai.json +``` + +AutoRest-Linter Suppressions + +``` yaml +# Ignore autorest-linter issues that cannot be resolved without breaking compatibility to existing openai api +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: Existing external API uses property names like n_epochs, created_at, not following naming/casing guidelines from azure. + - suppress: ValidFormats + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. + - suppress: IntegerTypeMustHaveFormat + reason: API stewardship board recommend to use format "unixtime" which is not supported by linter at the moment. +``` diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/azureopenai.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/azureopenai.json new file mode 100644 index 000000000000..e64315df48f2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/azureopenai.json @@ -0,0 +1,1508 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure OpenAI API version 2023-05-15", + "description": "APIs for fine-tuning and managing deployments of OpenAI models.", + "version": "2023-05-15" + }, + "paths": { + "/files": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets a list of all files owned by the Azure OpenAI resource.\r\nThese include user uploaded content like files with purpose \"fine-tune\" for training or validation of fine-tunes models\r\nas well as files that are generated by the service such as \"fine-tune-results\" which contains various metrics for the corresponding fine-tune job.", + "operationId": "Files_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FileList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all files owned by this account.": { + "$ref": "./examples/get_files.json" + } + } + }, + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by uploading data from a local machine. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Upload", + "consumes": [ + "multipart/form-data" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "formData", + "name": "purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "required": true, + "type": "string", + "enum": [ + "fine-tune", + "fine-tune-results" + ], + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + } + ] + } + }, + { + "in": "formData", + "name": "file", + "description": "Gets or sets the file to upload into Azure OpenAI.", + "required": true, + "type": "file" + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Upload a file.": { + "$ref": "./examples/upload_file.json" + } + } + } + }, + "/files/{file-id}": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets details for a single file specified by the given file-id including status, size, purpose, etc.", + "operationId": "Files_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/File" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a file.": { + "$ref": "./examples/get_file.json" + } + } + }, + "delete": { + "tags": [ + "Files:" + ], + "summary": "Deletes the file with the given file-id.\r\nDeletion is also allowed if a file was used, e.g., as training file in a fine-tune job.", + "operationId": "Files_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The file was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a file.": { + "$ref": "./examples/delete_file.json" + } + } + } + }, + "/files/{file-id}/content": { + "get": { + "tags": [ + "Files:" + ], + "summary": "Gets the content of the file specified by the given file-id.\r\nFiles can be user uploaded content or generated by the service like result metrics of a fine-tune job.", + "operationId": "Files_GetContent", + "produces": [ + "application/octet-stream", + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "file-id", + "description": "The identifier of the file.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "file" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting the file content.": { + "$ref": "./examples/get_file_content.json" + } + } + } + }, + "/files/import": { + "post": { + "tags": [ + "Files:" + ], + "summary": "Creates a new file entity by importing data from a provided url. Uploaded files can, for example, be used for training or evaluating fine-tuned models.", + "operationId": "Files_Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fileImport", + "description": "The definition of the file to create including its purpose, the file name and the url of the file location.", + "required": true, + "schema": { + "$ref": "#/definitions/FileImport" + } + } + ], + "responses": { + "201": { + "description": "The file has been successfully created.", + "schema": { + "$ref": "#/definitions/File" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Importing a file with a blob url as source.": { + "$ref": "./examples/import_file.json" + } + } + } + }, + "/fine-tunes": { + "get": { + "tags": [ + "Fine-tunes:" + ], + "summary": "Gets a list of all fine-tune jobs owned by the Azure OpenAI resource.\r\nThe details that are returned for each fine-tune job contain besides its identifier\r\nthe base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTunes_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTuneList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all fine tune jobs owned by this account.": { + "$ref": "./examples/get_finetunes.json" + } + } + }, + "post": { + "tags": [ + "Fine-tunes:" + ], + "summary": "Creates a job that fine-tunes a specified model from a given training file.\r\nResponse includes details of the enqueued job including job status and hyper parameters.\r\nThe name of the fine-tuned model is added to the response once complete.", + "operationId": "FineTunes_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + }, + { + "in": "body", + "name": "fineTune", + "description": "The specification of the fine-tuned model to create.\r\nRequired parameters are the base model and the training file to use.\r\nOptionally a validation file can be specified to compute validation metrics during training.\r\nHyper parameters will be set to default values or can by optionally specified.\r\nThese include batch size, learning rate multiplier, number of epochs and others.", + "required": true, + "schema": { + "$ref": "#/definitions/FineTuneCreation" + } + } + ], + "responses": { + "201": { + "description": "The fine tune has been successfully created.", + "schema": { + "$ref": "#/definitions/FineTune" + }, + "headers": { + "Location": { + "description": "The location of the newly created item.", + "type": "string", + "format": "url" + } + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creating a fine tune job.": { + "$ref": "./examples/post_finetune.json" + }, + "Creating a fine tune job for classification.": { + "$ref": "./examples/post_classification_finetune.json" + } + } + } + }, + "/fine-tunes/{fine-tune-id}": { + "get": { + "tags": [ + "Fine-tunes:" + ], + "summary": "Gets details for a single fine-tune job specified by the given fine-tune-id.\r\nThe details contain the base model, training and validation files, hyper parameters, time stamps, status and events.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTunes_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tune-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/FineTune" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a fine tune job.": { + "$ref": "./examples/get_finetune.json" + } + } + }, + "delete": { + "tags": [ + "Fine-tunes:" + ], + "summary": "Deletes the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTunes_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tune-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "204": { + "description": "The fine tune was successfully deleted." + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Deleting a fine tune job.": { + "$ref": "./examples/delete_finetune.json" + } + } + } + }, + "/fine-tunes/{fine-tune-id}/events": { + "get": { + "tags": [ + "Fine-tunes:" + ], + "summary": "Gets the events for the fine-tune job specified by the given fine-tune-id.\r\nEvents are created when the job status changes, e.g. running or complete, and when results are uploaded.", + "operationId": "FineTunes_GetEvents", + "produces": [ + "application/json", + "text/event-stream" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tune-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "in": "query", + "name": "stream", + "description": "A flag indicating whether to stream events for the fine-tune job. If set to true,\r\n events will be sent as data-only server-sent events as they become available. The stream will terminate with\r\n a data: [DONE] message when the job is finished (succeeded, cancelled, or failed).\r\n If set to false, only events generated so far will be returned..", + "type": "boolean" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EventList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting events of a fine tune job.": { + "$ref": "./examples/get_finetune_events.json" + } + } + } + }, + "/fine-tunes/{fine-tune-id}/cancel": { + "post": { + "tags": [ + "Fine-tunes:" + ], + "summary": "Cancels the processing of the fine-tune job specified by the given fine-tune-id.", + "operationId": "FineTunes_Cancel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "fine-tune-id", + "description": "The identifier of the fine-tune job.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "The fine tune has been successfully canceled", + "schema": { + "$ref": "#/definitions/FineTune" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Canceling a fine tune job.": { + "$ref": "./examples/cancel_finetune.json" + } + } + } + }, + "/models": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets a list of all models that are accessible by the Azure OpenAI resource.\r\nThese include base models as well as all successfully completed fine-tuned models owned by the Azure OpenAI resource.", + "operationId": "Models_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelList" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting all models owned by account.": { + "$ref": "./examples/get_models.json" + } + } + } + }, + "/models/{model-id}": { + "get": { + "tags": [ + "Models:" + ], + "summary": "Gets details for the model specified by the given modelId.", + "operationId": "Models_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "model-id", + "description": "The identifier of the model.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionQueryParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/Model" + } + }, + "default": { + "description": "An error occurred.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Getting a base model.": { + "$ref": "./examples/get_model_base.json" + }, + "Getting a fine-tuned model.": { + "$ref": "./examples/get_model_finetune.json" + } + } + } + } + }, + "definitions": { + "Capabilities": { + "title": "Capabilities", + "description": "The capabilities of a base or fine tune model.", + "required": [ + "chat_completion", + "completion", + "embeddings", + "fine_tune", + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "description": "A value indicating whether a model can be used for fine tuning.", + "type": "boolean" + }, + "inference": { + "description": "A value indicating whether a model can be deployed.", + "type": "boolean" + }, + "completion": { + "description": "A value indicating whether a model supports completion.", + "type": "boolean" + }, + "chat_completion": { + "description": "A value indicating whether a model supports chat completion.", + "type": "boolean" + }, + "embeddings": { + "description": "A value indicating whether a model supports embeddings.", + "type": "boolean" + } + } + }, + "Deprecation": { + "title": "Deprecation", + "description": "Defines the dates of deprecation for the different use cases of a model.\r\nUsually base models support 1 year of fine tuning after creation. Inference is typically supported 2 years after creation of base or\r\nfine tuned models. The exact dates are specified in the properties.", + "required": [ + "inference" + ], + "type": "object", + "properties": { + "fine_tune": { + "format": "unixtime", + "description": "The end date of fine tune support of this model. Will be `null` for fine tune models.", + "type": "integer" + }, + "inference": { + "format": "unixtime", + "description": "The end date of inference support of this model.", + "type": "integer" + } + } + }, + "Error": { + "title": "Error", + "description": "Error content as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "description": "The message of this error.", + "minLength": 1, + "type": "string" + }, + "target": { + "description": "The location where the error happened if available.", + "type": "string" + }, + "details": { + "description": "The error details if available.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "ErrorCode": { + "title": "ErrorCode", + "description": "Error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "conflict", + "invalidPayload", + "forbidden", + "notFound", + "unexpectedEntityState", + "itemDoesAlreadyExist", + "serviceUnavailable", + "internalFailure", + "quotaExceeded", + "jsonlValidationFailed", + "fileImportFailed" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true, + "values": [ + { + "value": "conflict", + "description": "The requested operation conflicts with the current resource state." + }, + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + }, + { + "value": "forbidden", + "description": "The operation is forbidden for the current user/api key." + }, + { + "value": "notFound", + "description": "The resource is not found." + }, + { + "value": "unexpectedEntityState", + "description": "The operation cannot be executed in the current resource's state." + }, + { + "value": "itemDoesAlreadyExist", + "description": "The item does already exist." + }, + { + "value": "serviceUnavailable", + "description": "The service is currently not available." + }, + { + "value": "internalFailure", + "description": "Internal error. Please retry." + }, + { + "value": "quotaExceeded", + "description": "Quota exceeded." + }, + { + "value": "jsonlValidationFailed", + "description": "Validation of jsonl data failed." + }, + { + "value": "fileImportFailed", + "description": "Import of file failed." + } + ] + } + }, + "ErrorResponse": { + "title": "ErrorResponse", + "description": "Error response as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "Event": { + "title": "Event", + "required": [ + "created_at", + "level", + "message" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this event was created (in unix epochs).", + "type": "integer" + }, + "level": { + "$ref": "#/definitions/LogLevel" + }, + "message": { + "description": "The message describing the event. This can be a change of state, e.g., enqueued, started, failed or completed, or other events like uploaded results.", + "minLength": 1, + "type": "string" + } + } + }, + "EventList": { + "title": "EventList", + "description": "Represents a list of events.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + } + } + }, + "File": { + "title": "File", + "description": "A file is a document usable for training and validation. It can also be a service generated document with result details.", + "required": [ + "filename", + "purpose" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "status": { + "$ref": "#/definitions/State" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "updated_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was modified last (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "bytes": { + "format": "int64", + "description": "The size of this file when available (can be null). File sizes larger than 2^53-1 are not supported to ensure compatibility\r\nwith JavaScript integers.", + "type": "integer", + "readOnly": true + }, + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the file.", + "minLength": 1, + "type": "string" + }, + "statistics": { + "$ref": "#/definitions/FileStatistics" + }, + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "FileImport": { + "title": "FileImport", + "description": "Defines a document to import from an external content url to be usable with Azure OpenAI.", + "required": [ + "content_url", + "filename", + "purpose" + ], + "type": "object", + "properties": { + "purpose": { + "$ref": "#/definitions/Purpose" + }, + "filename": { + "description": "The name of the [JSON Lines](https://jsonlines.readthedocs.io/en/latest/) file to be uploaded.\r\nIf the `purpose` is set to \"fine-tune\", each line is a JSON record with \"prompt\" and \"completion\" fields representing your training examples.", + "minLength": 1, + "type": "string" + }, + "content_url": { + "format": "url", + "description": "The url to download the document from (can be SAS url of a blob or any other external url accessible with a GET request).", + "type": "string" + } + } + }, + "FileList": { + "title": "FileList", + "description": "Represents a list of files.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + } + } + } + }, + "FileStatistics": { + "title": "FileStatistics", + "description": "A file is a document usable for training and validation. It can also be a service generated document with result details.", + "type": "object", + "properties": { + "tokens": { + "format": "int32", + "description": "The number of tokens used in prompts and completions for files of kind \"fine-tune\" once validation of file content is complete.", + "type": "integer" + }, + "examples": { + "format": "int32", + "description": "The number of contained training examples in files of kind \"fine-tune\" once validation of file content is complete.", + "type": "integer" + } + } + }, + "FineTune": { + "title": "FineTune", + "description": "Fine tuning is a job to tailor a model to specific training data.", + "required": [ + "model", + "training_files" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "status": { + "$ref": "#/definitions/State" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "updated_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was modified last (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "model": { + "description": "The identifier (model-id) of the base model used for the fine-tune.", + "minLength": 1, + "type": "string" + }, + "fine_tuned_model": { + "description": "The identifier (model-id) of the resulting fine tuned model. This property is only populated for successfully completed fine-tune runs.\r\nUse this identifier to create a deployment for inferencing.", + "type": "string" + }, + "training_files": { + "description": "The file identities (file-id) that are used for training the fine tuned model.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + } + }, + "validation_files": { + "description": "The file identities (file-id) that are used to evaluate the fine tuned model during training.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + } + }, + "result_files": { + "description": "The result file identities (file-id) containing training and evaluation metrics in csv format.\r\nThe file is only available for successfully completed fine-tune runs.", + "type": "array", + "items": { + "$ref": "#/definitions/File" + } + }, + "events": { + "description": "The events that show the progress of the fine-tune run including queued, running and completed.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + }, + "organisation_id": { + "description": "The organisation id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.", + "type": "string" + }, + "user_id": { + "description": "The user id of this fine tune job. Unused on Azure OpenAI; compatibility for OpenAI only.", + "type": "string" + }, + "hyperparams": { + "$ref": "#/definitions/HyperParameters" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model.", + "type": "string" + }, + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "FineTuneCreation": { + "title": "FineTuneCreation", + "description": "Defines the values of a fine tune job.", + "required": [ + "model", + "training_file" + ], + "type": "object", + "properties": { + "model": { + "description": "The identifier (model-id) of the base model used for this fine-tune.", + "minLength": 1, + "type": "string" + }, + "training_file": { + "description": "The file identity (file-id) that is used for training this fine tuned model.", + "minLength": 1, + "type": "string" + }, + "validation_file": { + "description": "The file identity (file-id) that is used to evaluate the fine tuned model during training.", + "type": "string" + }, + "suffix": { + "description": "The suffix used to identify the fine-tuned model. The suffix can contain up to 40 characters (a-z, A-Z, 0-9,- and _) that will be added to your fine-tuned model name.", + "type": "string" + }, + "n_epochs": { + "format": "int32", + "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", + "type": "integer" + }, + "batch_size": { + "format": "int32", + "description": "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model.", + "type": "integer" + }, + "learning_rate_multiplier": { + "format": "double", + "description": "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.", + "type": "number" + }, + "prompt_loss_weight": { + "format": "double", + "description": "The weight to use for loss on the prompt tokens. This controls how much the model tries to learn to generate the prompt\r\n(as compared to the completion which always has a weight of 1.0), and can add a stabilizing effect to training when completions are short.\r\nIf prompts are extremely long (relative to completions), it may make sense to reduce this weight so as to avoid over-prioritizing learning the prompt.", + "type": "number" + }, + "compute_classification_metrics": { + "description": "A value indicating whether to compute classification metrics.\r\nIf set, we calculate classification-specific metrics such as accuracy and F-1 score using the validation set at the end of every epoch.\r\nThese metrics can be viewed in the results file. In order to compute classification metrics, you must provide a validation_file.Additionally,\r\nyou must specify classification_n_classes for multiclass classification or classification_positive_class for binary classification.", + "type": "boolean" + }, + "classification_n_classes": { + "format": "int32", + "description": "The number of classes in a classification task.\r\nThis parameter is required for multiclass classification.", + "type": "integer" + }, + "classification_positive_class": { + "description": "The positive class in binary classification.\r\nThis parameter is needed to generate precision, recall, and F1 metrics when doing binary classification.", + "type": "string" + }, + "classification_betas": { + "description": "The classification beta values. If this is provided, we calculate F-beta scores at the specified beta values.\r\nThe F-beta score is a generalization of F-1 score. This is only used for binary classification.\r\nWith a beta of 1 (i.e.the F-1 score), precision and recall are given the same weight.\r\nA larger beta score puts more weight on recall and less on precision. A smaller beta score puts more weight on precision and less on recall.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + }, + "FineTuneList": { + "title": "FineTuneList", + "description": "Represents a list of fine tunes.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/FineTune" + } + } + } + }, + "HyperParameters": { + "title": "HyperParameters", + "description": "The hyper parameter settings used in a fine tune job.", + "type": "object", + "properties": { + "batch_size": { + "format": "int32", + "description": "The batch size to use for training. The batch size is the number of training examples used to train a single forward and backward pass.\r\nIn general, we've found that larger batch sizes tend to work better for larger datasets.\r\nThe default value as well as the maximum value for this property are specific to a base model.", + "type": "integer" + }, + "learning_rate_multiplier": { + "format": "double", + "description": "The learning rate multiplier to use for training. The fine-tuning learning rate is the original learning rate used for pre-training multiplied by this value.\r\nLarger learning rates tend to perform better with larger batch sizes.\r\nWe recommend experimenting with values in the range 0.02 to 0.2 to see what produces the best results.", + "type": "number" + }, + "n_epochs": { + "format": "int32", + "description": "The number of epochs to train the model for. An epoch refers to one full cycle through the training dataset.", + "type": "integer" + }, + "prompt_loss_weight": { + "format": "double", + "description": "The weight to use for loss on the prompt tokens. This controls how much the model tries to learn to generate the prompt\r\n(as compared to the completion which always has a weight of 1.0), and can add a stabilizing effect to training when completions are short.\r\nIf prompts are extremely long (relative to completions), it may make sense to reduce this weight so as to avoid over-prioritizing learning the prompt.", + "type": "number" + }, + "compute_classification_metrics": { + "description": "A value indicating whether to compute classification metrics.\r\nIf set, we calculate classification-specific metrics such as accuracy and F-1 score using the validation set at the end of every epoch.\r\nThese metrics can be viewed in the results file. In order to compute classification metrics, you must provide a validation_file.Additionally,\r\nyou must specify classification_n_classes for multiclass classification or classification_positive_class for binary classification.", + "type": "boolean" + }, + "classification_n_classes": { + "format": "int32", + "description": "The number of classes in a classification task.\r\nThis parameter is required for multiclass classification.", + "type": "integer" + }, + "classification_positive_class": { + "description": "The positive class in binary classification.\r\nThis parameter is needed to generate precision, recall, and F1 metrics when doing binary classification.", + "type": "string" + }, + "classification_betas": { + "description": "The classification beta values. If this is provided, we calculate F-beta scores at the specified beta values.\r\nThe F-beta score is a generalization of F-1 score. This is only used for binary classification.\r\nWith a beta of 1 (i.e.the F-1 score), precision and recall are given the same weight.\r\nA larger beta score puts more weight on recall and less on precision. A smaller beta score puts more weight on precision and less on recall.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + } + }, + "InnerError": { + "title": "InnerError", + "description": "Inner error as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/InnerErrorCode" + }, + "innererror": { + "$ref": "#/definitions/InnerError" + } + } + }, + "InnerErrorCode": { + "title": "InnerErrorCode", + "description": "Inner error codes as defined in the Microsoft REST guidelines\r\n(https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).", + "enum": [ + "invalidPayload" + ], + "type": "string", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true, + "values": [ + { + "value": "invalidPayload", + "description": "The request data is invalid for this operation." + } + ] + } + }, + "LifeCycleStatus": { + "title": "LifeCycleStatus", + "description": "The life cycle status of a model.\r\nNote: A model can be promoted from \"preview\" to \"generally-available\", but never from \"generally-available\" to \"preview\".", + "enum": [ + "preview", + "generally-available" + ], + "type": "string", + "x-ms-enum": { + "name": "LifeCycleStatus", + "modelAsString": true, + "values": [ + { + "value": "preview", + "description": "Model is in preview and covered by the service preview terms." + }, + { + "value": "generally-available", + "description": "Model is generally available." + } + ] + } + }, + "LogLevel": { + "title": "LogLevel", + "description": "The verbosity level of an event.", + "enum": [ + "info", + "warning", + "error" + ], + "type": "string", + "x-ms-enum": { + "name": "LogLevel", + "modelAsString": true, + "values": [ + { + "value": "info", + "description": "This event is for information only." + }, + { + "value": "warning", + "description": "This event represents a mitigated issue." + }, + { + "value": "error", + "description": "This message represents a non recoverable issue." + } + ] + } + }, + "Model": { + "title": "Model", + "description": "A model is either a base model or the result of a successful fine tune job.", + "required": [ + "capabilities", + "deprecation", + "lifecycle_status" + ], + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "status": { + "$ref": "#/definitions/State" + }, + "created_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was created (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "updated_at": { + "format": "unixtime", + "description": "A timestamp when this job or item was modified last (in unix epochs).", + "type": "integer", + "readOnly": true + }, + "id": { + "description": "The identity of this item.", + "type": "string", + "readOnly": true + }, + "model": { + "description": "The base model identity (model-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "fine_tune": { + "description": "The fine tune job identity (fine-tune-id) if this is a fine tune model; otherwise `null`.", + "type": "string" + }, + "capabilities": { + "$ref": "#/definitions/Capabilities" + }, + "lifecycle_status": { + "$ref": "#/definitions/LifeCycleStatus" + }, + "deprecation": { + "$ref": "#/definitions/Deprecation" + } + } + }, + "ModelList": { + "title": "ModelList", + "description": "Represents a list of models.", + "type": "object", + "properties": { + "object": { + "$ref": "#/definitions/TypeDiscriminator" + }, + "data": { + "description": "The list of items.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + } + } + }, + "Purpose": { + "title": "Purpose", + "description": "The intended purpose of the uploaded documents. Use \"fine-tune\" for fine-tuning. This allows us to validate the format of the uploaded file.", + "enum": [ + "fine-tune", + "fine-tune-results" + ], + "type": "string", + "x-ms-enum": { + "name": "Purpose", + "modelAsString": true, + "values": [ + { + "value": "fine-tune", + "description": "This file contains training data for a fine tune job." + }, + { + "value": "fine-tune-results", + "description": "This file contains the results of a fine tune job." + } + ] + } + }, + "State": { + "title": "State", + "description": "The state of a job or item.", + "enum": [ + "notRunning", + "running", + "succeeded", + "canceled", + "failed", + "deleted" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "value": "notRunning", + "description": "The operation was created and is not queued to be processed in the future." + }, + { + "value": "running", + "description": "The operation has started to be processed." + }, + { + "value": "succeeded", + "description": "The operation has successfully be processed and is ready for consumption." + }, + { + "value": "canceled", + "description": "The operation has been canceled and is incomplete." + }, + { + "value": "failed", + "description": "The operation has completed processing with a failure and cannot be further consumed." + }, + { + "value": "deleted", + "description": "The entity has been deleted but may still be referenced by other entities predating the deletion." + } + ] + } + }, + "TypeDiscriminator": { + "title": "TypeDiscriminator", + "description": "Defines the type of an object.", + "enum": [ + "list", + "fine-tune", + "file", + "fine-tune-event", + "model" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TypeDiscriminator", + "modelAsString": true, + "values": [ + { + "value": "list", + "description": "This object represents a list of other objects." + }, + { + "value": "fine-tune", + "description": "This object represents a fine tune job." + }, + { + "value": "file", + "description": "This object represents a file." + }, + { + "value": "fine-tune-event", + "description": "This object represents an event of a fine tune job." + }, + { + "value": "model", + "description": "This object represents a model (can be a base models or fine tune job result)." + }, + { + "value": "deployment", + "description": "This object represents a deployment." + } + ] + } + } + }, + "parameters": { + "endpoint": { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://aoairesource.openai.azure.com. Replace \"aoairesource\" with your Azure OpenAI account name).", + "required": true, + "type": "string", + "format": "url", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "apiVersionQueryParameter": { + "in": "query", + "name": "api-version", + "description": "The requested API version.", + "required": true, + "type": "string", + "x-ms-client-default": "2023-05-15", + "x-ms-parameter-location": "client" + } + }, + "securityDefinitions": { + "api-key": { + "type": "apiKey", + "name": "api-key", + "in": "header", + "description": "Provide your Cognitive Services Azure OpenAI account key here." + } + }, + "security": [ + { + "api-key": [] + } + ], + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/openai", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/cancel_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/cancel_finetune.json new file mode 100644 index 000000000000..6b95b39fb3f2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/cancel_finetune.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "fine-tune-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparams": { + "batch_size": 32, + "learning_rate_multiplier": 1, + "n_epochs": 2, + "prompt_loss_weight": 0.1 + }, + "model": "curie", + "training_files": [ + { + "statistics": { + "tokens": 42, + "examples": 23 + }, + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + ], + "events": [ + { + "created_at": 1646126127, + "level": "info", + "message": "Job enqueued. Waiting for jobs ahead to complete.", + "object": "fine-tune-event" + }, + { + "created_at": 1646126169, + "level": "info", + "message": "Job started.", + "object": "fine-tune-event" + }, + { + "created_at": 1646126192, + "level": "info", + "message": "Job canceled.", + "object": "fine-tune-event" + } + ], + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "canceled", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "fine-tune" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/delete_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/delete_file.json new file mode 100644 index 000000000000..cc2e24329ac0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/delete_file.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/delete_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/delete_finetune.json new file mode 100644 index 000000000000..bde0ed121f78 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/delete_finetune.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "fine-tune-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "204": { + "headers": {} + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_file.json new file mode 100644 index 000000000000..cb44585469bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_file.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "statistics": { + "tokens": 42, + "examples": 23 + }, + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_file_content.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_file_content.json new file mode 100644 index 000000000000..faf0d0d57ec0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_file_content.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "file-id": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "responses": { + "200": { + "headers": {}, + "body": "raw file content" + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_files.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_files.json new file mode 100644 index 000000000000..4d1e8cd03368 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_files.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + }, + { + "bytes": 32423, + "purpose": "fine-tune-results", + "filename": "results.csv", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetune.json new file mode 100644 index 000000000000..dcd3c1ad042c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetune.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "fine-tune-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "hyperparams": { + "batch_size": 32, + "learning_rate_multiplier": 1, + "n_epochs": 2, + "prompt_loss_weight": 0.1 + }, + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_files": [ + { + "statistics": { + "tokens": 42, + "examples": 23 + }, + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + ], + "result_files": [ + { + "bytes": 32423, + "purpose": "fine-tune-results", + "filename": "results.csv", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + ], + "events": [ + { + "created_at": 1646126127, + "level": "info", + "message": "Job enqueued. Waiting for jobs ahead to complete.", + "object": "fine-tune-event" + }, + { + "created_at": 1646126169, + "level": "info", + "message": "Job started.", + "object": "fine-tune-event" + }, + { + "created_at": 1646126192, + "level": "info", + "message": "Job succeeded.", + "object": "fine-tune-event" + } + ], + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "fine-tune" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetune_events.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetune_events.json new file mode 100644 index 000000000000..e954716817a9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetune_events.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "fine-tune-id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "created_at": 1646126127, + "level": "info", + "message": "Job enqueued. Waiting for jobs ahead to complete.", + "object": "fine-tune-event" + }, + { + "created_at": 1646126169, + "level": "info", + "message": "Job started.", + "object": "fine-tune-event" + }, + { + "created_at": 1646126192, + "level": "info", + "message": "Job succeeded.", + "object": "fine-tune-event" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetunes.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetunes.json new file mode 100644 index 000000000000..e1fc27daf92d --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_finetunes.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "hyperparams": { + "batch_size": 32, + "learning_rate_multiplier": 1, + "n_epochs": 2, + "prompt_loss_weight": 0.1 + }, + "model": "curie", + "fine_tuned_model": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "training_files": [ + { + "statistics": { + "tokens": 42, + "examples": 23 + }, + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + ], + "result_files": [ + { + "bytes": 32423, + "purpose": "fine-tune-results", + "filename": "results.csv", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + ], + "events": [ + { + "created_at": 1646126127, + "level": "info", + "message": "Job enqueued. Waiting for jobs ahead to complete.", + "object": "fine-tune-event" + }, + { + "created_at": 1646126169, + "level": "info", + "message": "Job started.", + "object": "fine-tune-event" + }, + { + "created_at": 1646126192, + "level": "info", + "message": "Job succeeded.", + "object": "fine-tune-event" + } + ], + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "fine-tune" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_model_base.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_model_base.json new file mode 100644 index 000000000000..a7d1654689cb --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_model_base.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "model-id": "curie" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_model_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_model_finetune.json new file mode 100644 index 000000000000..ae1ba22ea988 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_model_finetune.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "model-id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "model" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_models.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_models.json new file mode 100644 index 000000000000..dded64f5cb56 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/get_models.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "data": [ + { + "capabilities": { + "fine_tune": true, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "fine_tune": 1677662127, + "inference": 1709284527 + }, + "id": "curie", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "model" + }, + { + "model": "curie", + "fine_tune": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "capabilities": { + "fine_tune": false, + "inference": true, + "completion": true, + "chat_completion": false, + "embeddings": false + }, + "lifecycle_status": "generally-available", + "deprecation": { + "inference": 1709284527 + }, + "id": "curie.ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "model" + } + ], + "object": "list" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/import_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/import_file.json new file mode 100644 index 000000000000..f42e0325e5b3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/import_file.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "fileImport": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "content_url": "https://www.contoso.com/trainingdata/puppy.jsonl" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "notRunning", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/post_classification_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/post_classification_finetune.json new file mode 100644 index 000000000000..182932aa995c --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/post_classification_finetune.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "fineTune": { + "compute_classification_metrics": true, + "classification_n_classes": 4, + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/fine-tunes/ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "hyperparams": { + "compute_classification_metrics": true, + "classification_n_classes": 4, + "batch_size": 32, + "learning_rate_multiplier": 1, + "n_epochs": 2, + "prompt_loss_weight": 0.1 + }, + "model": "curie", + "training_files": [ + { + "statistics": { + "tokens": 42, + "examples": 23 + }, + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + ], + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "notRunning", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "fine-tune" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/post_finetune.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/post_finetune.json new file mode 100644 index 000000000000..eb5c83288b28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/post_finetune.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "fineTune": { + "model": "curie", + "training_file": "file-181a1cbdcdcf4677ada87f63a0928099" + }, + "content-Type": "application/json" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/fine-tunes/ft-72a2792ef7d24ba7b82c7fe4a37e379f" + }, + "body": { + "hyperparams": { + "batch_size": 32, + "learning_rate_multiplier": 1, + "n_epochs": 2, + "prompt_loss_weight": 0.1 + }, + "model": "curie", + "training_files": [ + { + "statistics": { + "tokens": 42, + "examples": 23 + }, + "bytes": 140, + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "succeeded", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + ], + "id": "ft-72a2792ef7d24ba7b82c7fe4a37e379f", + "status": "notRunning", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "fine-tune" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/upload_file.json b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/upload_file.json new file mode 100644 index 000000000000..24ea30c8a464 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/stable/2023-05-15/examples/upload_file.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "endpoint": "https://aoairesource.openai.azure.com", + "api-key": "{api key}", + "api-version": "2023-05-15", + "purpose": "fine-tune", + "content-Type": "multipart/form-data", + "file": "raw file content" + }, + "responses": { + "201": { + "headers": { + "location": "https://aoairesource.openai.azure.com/openai/files/file-181a1cbdcdcf4677ada87f63a0928099" + }, + "body": { + "purpose": "fine-tune", + "filename": "puppy.jsonl", + "id": "file-181a1cbdcdcf4677ada87f63a0928099", + "status": "notRunning", + "created_at": 1646126127, + "updated_at": 1646127311, + "object": "file" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/inference.json b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/inference.json new file mode 100644 index 000000000000..1f4b77da87f7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2023-05-15/inference.json @@ -0,0 +1,816 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "Azure OpenAI Service API", + "description": "Azure OpenAI APIs for completions and search", + "version": "2023-05-15" + }, + "servers": [ + { + "url": "https://{endpoint}/openai", + "variables": { + "endpoint": { + "default": "your-resource-name.openai.azure.com" + } + } + } + ], + "security": [ + { + "bearer": [ + "api.read" + ] + }, + { + "apiKey": [] + } + ], + "paths": { + "/deployments/{deployment-id}/completions": { + "post": { + "summary": "Creates a completion for the provided prompt, parameters and chosen model.", + "operationId": "Completions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "davinci", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2023-05-15", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "prompt": { + "description": "The prompt(s) to generate completions for, encoded as a string or array of strings.\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document. Maximum allowed size of string list is 2048.", + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test.", + "nullable": true + }, + { + "type": "array", + "items": { + "type": "string", + "default": "", + "example": "This is a test.", + "nullable": false + }, + "description": "Array size minimum of 1 and maximum of 2048" + } + ] + }, + "max_tokens": { + "description": "The token count of your prompt plus max_tokens cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096). Has minimum of 0.", + "type": "integer", + "default": 16, + "example": 16, + "nullable": true + }, + "temperature": { + "description": "What sampling temperature to use. Higher values means the model will take more risks. Try 0.9 for more creative applications, and 0 (argmax sampling) for ones with a well-defined answer.\nWe generally recommend altering this or top_p but not both.", + "type": "number", + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\nWe generally recommend altering this or temperature but not both.", + "type": "number", + "default": 1, + "example": 1, + "nullable": true + }, + "logit_bias": { + "description": "Defaults to null. Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this tokenizer tool (which works for both GPT-2 and GPT-3) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. As an example, you can pass {\"50256\" : -100} to prevent the <|endoftext|> token from being generated.", + "type": "object", + "nullable": false + }, + "user": { + "description": "A unique identifier representing your end-user, which can help monitoring and detecting abuse", + "type": "string", + "nullable": false + }, + "n": { + "description": "How many completions to generate for each prompt. Minimum of 1 and maximum of 128 allowed.\nNote: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop.", + "type": "integer", + "default": 1, + "example": 1, + "nullable": true + }, + "stream": { + "description": "Whether to stream back partial progress. If set, tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.", + "type": "boolean", + "nullable": true, + "default": false + }, + "logprobs": { + "description": "Include the log probabilities on the logprobs most likely tokens, as well the chosen tokens. For example, if logprobs is 5, the API will return a list of the 5 most likely tokens. The API will always return the logprob of the sampled token, so there may be up to logprobs+1 elements in the response.\nMinimum of 0 and maximum of 5 allowed.", + "type": "integer", + "default": null, + "nullable": true + }, + "model": { + "type": "string", + "example": "davinci", + "nullable": true, + "description": "ID of the model to use. You can use the Models_List operation to see all of your available models, or see our Models_Get overview for descriptions of them." + }, + "suffix": { + "type": "string", + "nullable": true, + "description": "The suffix that comes after a completion of inserted text." + }, + "echo": { + "description": "Echo back the prompt in addition to the completion", + "type": "boolean", + "default": false, + "nullable": true + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.", + "oneOf": [ + { + "type": "string", + "default": "<|endoftext|>", + "example": "\n", + "nullable": true + }, + { + "type": "array", + "items": { + "type": "string", + "example": [ + "\n" + ], + "nullable": false + }, + "description": "Array minimum size of 1 and maximum of 4" + } + ] + }, + "completion_config": { + "type": "string", + "nullable": true + }, + "cache_level": { + "description": "can be used to disable any server-side caching, 0=no cache, 1=prompt prefix enabled, 2=full cache", + "type": "integer", + "nullable": true + }, + "presence_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.", + "type": "number", + "default": 0 + }, + "frequency_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.", + "type": "number", + "default": 0 + }, + "best_of": { + "description": "Generates best_of completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\nWhen used with n, best_of controls the number of candidate completions and n specifies how many to return – best_of must be greater than n.\nNote: Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for max_tokens and stop. Has maximum value of 128.", + "type": "integer" + } + } + }, + "example": { + "prompt": "Negate the following sentence.The price for bubblegum increased on thursday.\n\n Negated Sentence:", + "max_tokens": 50 + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "object": { + "type": "string" + }, + "created": { + "type": "integer" + }, + "model": { + "type": "string" + }, + "choices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "logprobs": { + "type": "object", + "properties": { + "tokens": { + "type": "array", + "items": { + "type": "string" + } + }, + "token_logprobs": { + "type": "array", + "items": { + "type": "number" + } + }, + "top_logprobs": { + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "number" + } + } + }, + "text_offset": { + "type": "array", + "items": { + "type": "integer" + } + } + } + }, + "finish_reason": { + "type": "string" + } + } + } + }, + "usage": { + "type": "object", + "properties": { + "completion_tokens": { + "type": "number", + "format": "int32" + }, + "prompt_tokens": { + "type": "number", + "format": "int32" + }, + "total_tokens": { + "type": "number", + "format": "int32" + } + }, + "required": [ + "prompt_tokens", + "total_tokens", + "completion_tokens" + ] + } + }, + "required": [ + "id", + "object", + "created", + "model", + "choices" + ] + }, + "example": { + "model": "davinci", + "object": "text_completion", + "id": "cmpl-4509KAos68kxOqpE2uYGw81j6m7uo", + "created": 1637097562, + "choices": [ + { + "index": 0, + "text": "The price for bubblegum decreased on thursday.", + "logprobs": null, + "finish_reason": "stop" + } + ] + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + }, + "default": { + "description": "Service unavailable", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/errorResponse" + } + } + }, + "headers": { + "apim-request-id": { + "description": "Request ID for troubleshooting purposes", + "schema": { + "type": "string" + } + } + } + } + } + } + }, + "/deployments/{deployment-id}/embeddings": { + "post": { + "summary": "Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.", + "operationId": "embeddings_create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "example": "ada-search-index-v1" + }, + "description": "The deployment id of the model which was deployed." + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2023-05-15", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "additionalProperties": true, + "properties": { + "input": { + "description": "Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length.\nUnless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space, as we have observed inferior results when newlines are present.", + "oneOf": [ + { + "type": "string", + "default": "", + "example": "This is a test.", + "nullable": true + }, + { + "type": "array", + "minItems": 1, + "maxItems": 2048, + "items": { + "type": "string", + "minLength": 1, + "example": "This is a test.", + "nullable": false + } + } + ] + }, + "user": { + "description": "A unique identifier representing your end-user, which can help monitoring and detecting abuse.", + "type": "string", + "nullable": false + }, + "input_type": { + "description": "input type of embedding search to use", + "type": "string", + "example": "query" + }, + "model": { + "type": "string", + "description": "ID of the model to use. You can use the Models_List operation to see all of your available models, or see our Models_Get overview for descriptions of them.", + "nullable": false + } + }, + "required": [ + "input" + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "object": { + "type": "string" + }, + "model": { + "type": "string" + }, + "data": { + "type": "array", + "items": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "object": { + "type": "string" + }, + "embedding": { + "type": "array", + "items": { + "type": "number" + } + } + }, + "required": [ + "index", + "object", + "embedding" + ] + } + }, + "usage": { + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "total_tokens": { + "type": "integer" + } + }, + "required": [ + "prompt_tokens", + "total_tokens" + ] + } + }, + "required": [ + "object", + "model", + "data", + "usage" + ] + } + } + } + } + } + } + }, + "/deployments/{deployment-id}/chat/completions": { + "post": { + "summary": "Creates a completion for the chat message", + "operationId": "ChatCompletions_Create", + "parameters": [ + { + "in": "path", + "name": "deployment-id", + "required": true, + "schema": { + "type": "string", + "description": "Deployment id of the model which was deployed." + } + }, + { + "in": "query", + "name": "api-version", + "required": true, + "schema": { + "type": "string", + "example": "2023-05-15", + "description": "api version" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "messages": { + "description": "The messages to generate chat completions for, in the chat format.", + "type": "array", + "minItems": 1, + "items": { + "type": "object", + "properties": { + "role": { + "type": "string", + "enum": [ + "system", + "user", + "assistant" + ], + "description": "The role of the author of this message." + }, + "content": { + "type": "string", + "description": "The contents of the message" + }, + "name": { + "type": "string", + "description": "The name of the user in a multi-user chat" + } + }, + "required": [ + "role", + "content" + ] + } + }, + "temperature": { + "description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\nWe generally recommend altering this or `top_p` but not both.", + "type": "number", + "minimum": 0, + "maximum": 2, + "default": 1, + "example": 1, + "nullable": true + }, + "top_p": { + "description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\nWe generally recommend altering this or `temperature` but not both.", + "type": "number", + "minimum": 0, + "maximum": 1, + "default": 1, + "example": 1, + "nullable": true + }, + "n": { + "description": "How many chat completion choices to generate for each input message.", + "type": "integer", + "minimum": 1, + "maximum": 128, + "default": 1, + "example": 1, + "nullable": true + }, + "stream": { + "description": "If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a `data: [DONE]` message.", + "type": "boolean", + "nullable": true, + "default": false + }, + "stop": { + "description": "Up to 4 sequences where the API will stop generating further tokens.", + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "array", + "items": { + "type": "string", + "nullable": false + }, + "minItems": 1, + "maxItems": 4, + "description": "Array minimum size of 1 and maximum of 4" + } + ], + "default": null + }, + "max_tokens": { + "description": "The maximum number of tokens allowed for the generated answer. By default, the number of tokens the model can return will be (4096 - prompt tokens).", + "type": "integer", + "default": "inf" + }, + "presence_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "frequency_penalty": { + "description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.", + "type": "number", + "default": 0, + "minimum": -2, + "maximum": 2 + }, + "logit_bias": { + "description": "Modify the likelihood of specified tokens appearing in the completion. Accepts a json object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.", + "type": "object", + "nullable": true + }, + "user": { + "description": "A unique identifier representing your end-user, which can help Azure OpenAI to monitor and detect abuse.", + "type": "string", + "example": "user-1234", + "nullable": false + } + }, + "required": [ + "messages" + ] + }, + "example": { + "model": "gpt-35-turbo", + "messages": [ + { + "role": "user", + "content": "Hello!" + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "object": { + "type": "string" + }, + "created": { + "type": "integer", + "format": "unixtime" + }, + "model": { + "type": "string" + }, + "choices": { + "type": "array", + "items": { + "type": "object", + "properties": { + "index": { + "type": "integer" + }, + "message": { + "type": "object", + "properties": { + "role": { + "type": "string", + "enum": [ + "system", + "user", + "assistant" + ], + "description": "The role of the author of this message." + }, + "content": { + "type": "string", + "description": "The contents of the message" + } + }, + "required": [ + "role", + "content" + ] + }, + "finish_reason": { + "type": "string" + } + } + } + }, + "usage": { + "type": "object", + "properties": { + "prompt_tokens": { + "type": "integer" + }, + "completion_tokens": { + "type": "integer" + }, + "total_tokens": { + "type": "integer" + } + }, + "required": [ + "prompt_tokens", + "completion_tokens", + "total_tokens" + ] + } + }, + "required": [ + "id", + "object", + "created", + "model", + "choices" + ] + }, + "example": { + "id": "chatcmpl-123", + "object": "chat.completion", + "created": 1677652288, + "choices": [ + { + "index": 0, + "message": { + "role": "assistant", + "content": "\n\nHello there, how may I assist you today?" + }, + "finish_reason": "stop" + } + ], + "usage": { + "prompt_tokens": 9, + "completion_tokens": 12, + "total_tokens": 21 + } + } + } + } + } + } + } + } + }, + "components": { + "schemas": { + "errorResponse": { + "type": "object", + "properties": { + "error": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "param": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + } + } + }, + "securitySchemes": { + "bearer": { + "type": "oauth2", + "flows": { + "implicit": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", + "scopes": {} + } + }, + "x-tokenInfoFunc": "api.middleware.auth.bearer_auth", + "x-scopeValidateFunc": "api.middleware.auth.validate_scopes" + }, + "apiKey": { + "type": "apiKey", + "name": "api-key", + "in": "header" + } + } + } +} From ab45fad5dc6bb4d36ede9eb15460eb26be8a5b11 Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Wed, 3 May 2023 01:21:36 +0800 Subject: [PATCH 04/79] Update readme.python.md (#23782) --- specification/monitor/resource-manager/readme.python.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/monitor/resource-manager/readme.python.md b/specification/monitor/resource-manager/readme.python.md index c9c9fbca1f6c..d181d1cf151b 100644 --- a/specification/monitor/resource-manager/readme.python.md +++ b/specification/monitor/resource-manager/readme.python.md @@ -9,6 +9,7 @@ license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-monitor no-namespace-folders: true package-version: 1.0.0b1 +python-base-namespace: azure.mgmt.monitor python-base-folder: monitor/azure-mgmt-monitor/azure/mgmt/monitor ``` From ccae65b66ac23a9fd891ba86f45abc4372a9c688 Mon Sep 17 00:00:00 2001 From: Sean McCullough <44180881+seanmcc-msft@users.noreply.github.com> Date: Tue, 2 May 2023 14:25:57 -0500 Subject: [PATCH 05/79] Storage STG 88 (#23735) * Added 2023-01-03 Files swagger (#22776) * List Handles Access Rights (#22779) --- .../preview/2023-01-03/file.json | 7401 +++++++++++++++++ .../Microsoft.FileStorage/readme.md | 11 +- 2 files changed, 7411 insertions(+), 1 deletion(-) create mode 100644 specification/storage/data-plane/Microsoft.FileStorage/preview/2023-01-03/file.json diff --git a/specification/storage/data-plane/Microsoft.FileStorage/preview/2023-01-03/file.json b/specification/storage/data-plane/Microsoft.FileStorage/preview/2023-01-03/file.json new file mode 100644 index 000000000000..88dc11b81de2 --- /dev/null +++ b/specification/storage/data-plane/Microsoft.FileStorage/preview/2023-01-03/file.json @@ -0,0 +1,7401 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure File Storage", + "version": "2023-01-03", + "x-ms-code-generation-settings": { + "header": "MIT", + "strictSpecAdherence": false + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{url}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/Url" + } + ] + }, + "securityDefinitions": { + "File_shared_key": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/xml" + ], + "produces": [ + "application/xml" + ], + "paths": {}, + "x-ms-paths": { + "/?restype=service&comp=properties": { + "put": { + "tags": [ + "service" + ], + "operationId": "Service_SetProperties", + "description": "Sets properties for a storage account's File service endpoint, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/StorageServiceProperties" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Success (Accepted)", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "service" + ], + "operationId": "Service_GetProperties", + "description": "Gets the properties of a storage account's File service, including properties for Storage Analytics metrics and CORS (Cross-Origin Resource Sharing) rules.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + }, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "service" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/?comp=list": { + "get": { + "tags": [ + "service" + ], + "operationId": "Service_ListSharesSegment", + "description": "The List Shares Segment operation returns a list of the shares and share snapshots under the specified account.", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/ListSharesInclude" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + } + }, + "schema": { + "$ref": "#/definitions/ListSharesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{shareName}?restype=share": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_Create", + "description": "Creates a new share under the specified account. If the share with the same name already exists, the operation fails.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ShareQuota" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareEnabledProtocols" + }, + { + "$ref": "#/parameters/ShareRootSquash" + } + ], + "responses": { + "201": { + "description": "Success, Share created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the share, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetProperties", + "description": "Returns all user-defined metadata and system properties for the specified share or share snapshot. The data returned does not include the share's list of files.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs that contain the user-defined metadata of the share.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-share-quota": { + "x-ms-client-name": "Quota", + "type": "integer", + "description": "Returns the current share quota in GB." + }, + "x-ms-share-provisioned-iops": { + "x-ms-client-name": "ProvisionedIops", + "type": "integer", + "description": "Returns the current share provisioned ipos." + }, + "x-ms-share-provisioned-ingress-mbps": { + "x-ms-client-name": "ProvisionedIngressMBps", + "type": "integer", + "description": "Returns the current share provisioned ingress in megabytes per second." + }, + "x-ms-share-provisioned-egress-mbps": { + "x-ms-client-name": "ProvisionedEgressMBps", + "type": "integer", + "description": "Returns the current share provisioned egress in megabytes per second." + }, + "x-ms-share-next-allowed-quota-downgrade-time": { + "x-ms-client-name": "NextAllowedQuotaDowngradeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the current share next allowed quota downgrade time." + }, + "x-ms-share-provisioned-bandwidth-mibps": { + "x-ms-client-name": "ProvisionedBandwidthMibps", + "type": "integer", + "description": "Returns the current share provisioned bandwidth in megabits per second." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the share.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the share.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "x-ms-access-tier": { + "x-ms-client-name": "AccessTier", + "type": "string", + "description": "Returns the access tier set on the share." + }, + "x-ms-access-tier-change-time": { + "x-ms-client-name": "AccessTierChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the last modified time (in UTC) of the access tier of the share." + }, + "x-ms-access-tier-transition-state": { + "x-ms-client-name": "AccessTierTransitionState", + "type": "string", + "description": "Returns the transition state between access tiers, when present." + }, + "x-ms-enabled-protocols": { + "x-ms-client-name": "EnabledProtocols", + "description": "The protocols that have been enabled on the share.", + "type": "string" + }, + "x-ms-root-squash": { + "x-ms-client-name": "RootSquash", + "description": "Valid for NFS shares only.", + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "share" + ], + "operationId": "Share_Delete", + "description": "Operation marks the specified share or share snapshot for deletion. The share or share snapshot and any files contained within it are later deleted during garbage collection.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/DeleteSnapshots" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&acquire": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_AcquireLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&release": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_ReleaseLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&change": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_ChangeLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&renew": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_RenewLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ClientRequestId" + } + ], + "responses": { + "200": { + "description": "The Renew operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the current share next allowed quota downgrade time." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "renew" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=lease&break": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_BreakLease", + "description": "The Lease Share operation establishes and manages a lock on a share, or the specified snapshot for set and delete share operations.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseBreakPeriod" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ShareSnapshot" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-lease-time": { + "x-ms-client-name": "LeaseTime", + "type": "integer", + "description": "Approximate time remaining in the lease period, in seconds." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a share's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + } + ] + }, + "/{shareName}?restype=share&comp=snapshot": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_CreateSnapshot", + "description": "Creates a read-only snapshot of a share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Success, Share snapshot created.", + "headers": { + "x-ms-snapshot": { + "x-ms-client-name": "Snapshot", + "type": "string", + "description": "This header is a DateTime value that uniquely identifies the share snapshot. The value of this header may be used in subsequent requests to access the share snapshot. This value is opaque." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the share snapshot, in quotes. A share snapshot cannot be modified, so the ETag of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the ETag of the share snapshot differs from that of the base share. If no metadata was specified with the request, the ETag of the share snapshot is identical to that of the base share at the time the share snapshot was taken." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. A share snapshot cannot be modified, so the last modified time of a given share snapshot never changes. However, if new metadata was supplied with the Snapshot Share request then the last modified time of the share snapshot differs from that of the base share. If no metadata was specified with the request, the last modified time of the share snapshot is identical to that of the base share at the time the share snapshot was taken." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "snapshot" + ] + } + ] + }, + "/{shareName}?restype=share&comp=filepermission": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_CreatePermission", + "description": "Create a permission (a security descriptor).", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SharePermission" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success, Share level permission created.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory/file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetPermission", + "description": "Returns the permission (security descriptor) for a given key", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/FilePermissionKeyRequired" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/SharePermission" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "filepermission" + ] + } + ] + }, + "/{shareName}?restype=share&comp=properties": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetProperties", + "description": "Sets properties for the specified share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShareQuota" + }, + { + "$ref": "#/parameters/AccessTierOptional" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ShareRootSquash" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}?restype=share&comp=metadata": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetMetadata", + "description": "Sets one or more user-defined name-value pairs for the specified share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}?restype=share&comp=acl": { + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetAccessPolicy", + "description": "Returns information about stored access policies specified on the share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "put": { + "tags": [ + "share" + ], + "operationId": "Share_SetAccessPolicy", + "description": "Sets a stored access policy for use with shared access signatures.", + "parameters": [ + { + "$ref": "#/parameters/ShareAcl" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "acl" + ] + } + ] + }, + "/{shareName}?restype=share&comp=stats": { + "get": { + "tags": [ + "share" + ], + "operationId": "Share_GetStatistics", + "description": "Retrieves statistics related to the share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ShareStats" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "stats" + ] + } + ] + }, + "/{shareName}?restype=share&comp=undelete": { + "put": { + "tags": [ + "share" + ], + "operationId": "Share_Restore", + "description": "Restores a previously deleted Share.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/DeletedShareName" + }, + { + "$ref": "#/parameters/DeletedShareVersion" + } + ], + "responses": { + "201": { + "description": "Created", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the share or its properties updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "share" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "undelete" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_Create", + "description": "Creates a new directory under the specified share or parent directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success, Directory created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the directory, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_GetProperties", + "description": "Returns all system properties for the specified directory, and can also be used to check the existence of a directory. The data returned does not include the files in the directory or any subdirectories.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs that contain metadata for the directory.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the Directory was last modified. Operations on files within the directory do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the directory metadata is completely encrypted using the specified algorithm. Otherwise, the value is set to false." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "directory" + ], + "operationId": "Directory_Delete", + "description": "Removes the specified empty directory. Note that the directory must be empty before it can be deleted.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "Success (Accepted).", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "$ref": "#/parameters/AllowTrailingDot" + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=properties": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_SetProperties", + "description": "Sets properties on the directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the directory." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the directory." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the directory." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the directory." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the directory." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=metadata": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_SetMetadata", + "description": "Updates user defined metadata for the specified directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success (OK).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the directory, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=list": { + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_ListFilesAndDirectoriesSegment", + "description": "Returns a list of files or directories under the specified share or directory. It lists the contents only for a single level of the directory hierarchy.", + "parameters": [ + { + "$ref": "#/parameters/Prefix" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ListFilesInclude" + }, + { + "$ref": "#/parameters/ListFilesExtendedInfo" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ListFilesAndDirectoriesSegmentResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "NextMarker" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "list" + ] + } + ] + }, + "/{shareName}/{directory}?comp=listhandles": { + "get": { + "tags": [ + "directory" + ], + "operationId": "Directory_ListHandles", + "description": "Lists handles for directory.", + "parameters": [ + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Recursive" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ListHandlesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "listhandles" + ] + } + ] + }, + "/{shareName}/{directory}?comp=forceclosehandles": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_ForceCloseHandles", + "description": "Closes all handles open for given directory.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/HandleId" + }, + { + "$ref": "#/parameters/Recursive" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-marker": { + "x-ms-client-name": "marker", + "type": "string", + "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request." + }, + "x-ms-number-of-handles-closed": { + "x-ms-client-name": "numberOfHandlesClosed", + "type": "integer", + "description": "Contains count of number of handles closed." + }, + "x-ms-number-of-handles-failed": { + "x-ms-client-name": "numberOfHandlesFailedToClose", + "type": "integer", + "description": "Contains count of number of handles that failed to close." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "forceclosehandles" + ] + } + ] + }, + "/{shareName}/{directory}?restype=directory&comp=rename": { + "put": { + "tags": [ + "directory" + ], + "operationId": "Directory_Rename", + "description": "Renames a directory", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RenameSource" + }, + { + "$ref": "#/parameters/RenameReplaceIfExists" + }, + { + "$ref": "#/parameters/RenameIgnoreReadOnly" + }, + { + "$ref": "#/parameters/SourceLeaseId" + }, + { + "$ref": "#/parameters/DestinationLeaseId" + }, + { + "$ref": "#/parameters/FileCopyFileAttributes" + }, + { + "$ref": "#/parameters/FileCopyFileCreationTime" + }, + { + "$ref": "#/parameters/FileCopyFileLastWriteTime" + }, + { + "$ref": "#/parameters/FileCopyFileChangeTime" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "name": "restype", + "description": "restype", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "directory" + ] + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rename" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_Create", + "description": "Creates a new file or replaces a file. Note it only initializes the file with no content.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-content-length", + "x-ms-client-name": "fileContentLength", + "in": "header", + "description": "Specifies the maximum size for the file, up to 4 TB.", + "required": true, + "type": "integer", + "format": "int64" + }, + { + "$ref": "#/parameters/FileType" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/FileContentEncoding" + }, + { + "$ref": "#/parameters/FileContentLanguage" + }, + { + "$ref": "#/parameters/FileCacheControl" + }, + { + "$ref": "#/parameters/FileContentMD5" + }, + { + "$ref": "#/parameters/FileContentDisposition" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success, File created.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "get": { + "tags": [ + "file" + ], + "operationId": "File_Download", + "description": "Reads or downloads a file from the system, including its metadata and properties.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Range" + }, + { + "$ref": "#/parameters/GetRangeContentMD5" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Succeeded to read the entire file.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header." + }, + "Content-Encoding": { + "type": "string", + "description": "Returns the value that was specified for the Content-Encoding request header." + }, + "Cache-Control": { + "type": "string", + "description": "Returned if it was previously specified for the file." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-content-md5": { + "x-ms-client-name": "FileContentMD5", + "type": "string", + "format": "byte", + "description": "If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "206": { + "description": "Succeeded to read a specified range of the file.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The number of bytes present in the response body." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "Content-Range": { + "type": "string", + "description": "Indicates the range of bytes returned if the client requested a subset of the file by setting the Range request header." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the file has an MD5 hash and the request is to read the full file, this response header is returned so that the client can check for message content integrity. If the request is to read a specified range and the 'x-ms-range-get-content-md5' is set to true, then the request returns an MD5 hash for the range, as long as the range size is less than or equal to 4 MB. If neither of these sets of conditions is true, then no value is returned for the 'Content-MD5' header." + }, + "Content-Encoding": { + "type": "string", + "description": "Returns the value that was specified for the Content-Encoding request header." + }, + "Cache-Control": { + "type": "string", + "description": "Returned if it was previously specified for the file." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Accept-Ranges": { + "type": "string", + "description": "Indicates that the service supports requests for partial file content." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-content-md5": { + "x-ms-client-name": "FileContentMD5", + "type": "string", + "format": "byte", + "description": "If the file has a MD5 hash, and if request contains range header (Range or x-ms-range), this response header is returned with the value of the whole file's MD5 value. This value may or may not be equal to the value returned in Content-MD5 header, with the latter calculated from the requested range." + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + } + }, + "schema": { + "type": "object", + "format": "file" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "head": { + "tags": [ + "file" + ], + "operationId": "File_GetProperties", + "description": "Returns all user-defined metadata, standard HTTP properties, and system properties for the file. It does not return the content of the file.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. The date format follows RFC 1123. Any operation that modifies the file or its properties updates the last modified time." + }, + "x-ms-meta": { + "type": "string", + "description": "A set of name-value pairs associated with this file as user-defined metadata.", + "x-ms-client-name": "Metadata", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "x-ms-type": { + "x-ms-client-name": "FileType", + "description": "Returns the type File. Reserved for future use.", + "type": "string", + "enum": [ + "File" + ] + }, + "Content-Length": { + "type": "integer", + "format": "int64", + "description": "The size of the file in bytes. This header returns the value of the 'x-ms-content-length' header that is stored with the file." + }, + "Content-Type": { + "type": "string", + "description": "The content type specified for the file. The default content type is 'application/octet-stream'" + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally, in quotes." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "If the Content-MD5 header has been set for the file, the Content-MD5 response header is returned so that the client can check for message content integrity." + }, + "Content-Encoding": { + "type": "string", + "description": "If the Content-Encoding request header has previously been set for the file, the Content-Encoding value is returned in this header." + }, + "Cache-Control": { + "type": "string", + "description": "If the Cache-Control request header has previously been set for the file, the Cache-Control value is returned in this header." + }, + "Content-Disposition": { + "type": "string", + "description": "Returns the value that was specified for the 'x-ms-content-disposition' header and specifies how to process the response." + }, + "Content-Language": { + "type": "string", + "description": "Returns the value that was specified for the Content-Language request header." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-completion-time": { + "x-ms-client-name": "CopyCompletionTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Conclusion time of the last attempted Copy File operation where this file was the destination file. This value can specify the time of a completed, aborted, or failed copy attempt." + }, + "x-ms-copy-status-description": { + "x-ms-client-name": "CopyStatusDescription", + "type": "string", + "description": "Only appears when x-ms-copy-status is failed or pending. Describes cause of fatal or non-fatal copy operation failure." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-progress": { + "x-ms-client-name": "CopyProgress", + "type": "string", + "description": "Contains the number of bytes copied and the total bytes in the source in the last attempted Copy File operation where this file was the destination file. Can show between 0 and Content-Length bytes copied." + }, + "x-ms-copy-source": { + "x-ms-client-name": "CopySource", + "type": "string", + "description": "URL up to 2KB in length that specifies the source file used in the last attempted Copy File operation where this file was the destination file." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by 'x-ms-copy-id'.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + }, + "x-ms-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the file data and application metadata are completely encrypted using the specified algorithm. Otherwise, the value is set to false (when the file is unencrypted, or if only parts of the file/application metadata are encrypted)." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the file." + }, + "x-ms-lease-duration": { + "x-ms-client-name": "LeaseDuration", + "description": "When a file is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "x-ms-lease-state": { + "x-ms-client-name": "LeaseState", + "description": "Lease state of the file.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "x-ms-lease-status": { + "x-ms-client-name": "LeaseStatus", + "description": "The current lease status of the file.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "delete": { + "tags": [ + "file" + ], + "operationId": "File_Delete", + "description": "removes the file from the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "Success (Accepted).", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=properties": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_SetHTTPHeaders", + "description": "Sets HTTP headers on the file.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-content-length", + "x-ms-client-name": "fileContentLength", + "in": "header", + "description": "Resizes a file to the specified size. If the specified byte value is less than the current size of the file, then all ranges above the specified byte value are cleared.", + "required": false, + "type": "integer", + "format": "int64" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/FileContentEncoding" + }, + { + "$ref": "#/parameters/FileContentLanguage" + }, + { + "$ref": "#/parameters/FileCacheControl" + }, + { + "$ref": "#/parameters/FileContentMD5" + }, + { + "$ref": "#/parameters/FileContentDisposition" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileAttributes" + }, + { + "$ref": "#/parameters/FileCreationTime" + }, + { + "$ref": "#/parameters/FileLastWriteTime" + }, + { + "$ref": "#/parameters/FileChangeTime" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the directory." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "properties" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=metadata": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_SetMetadata", + "description": "Updates user-defined metadata for the specified file.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success (OK).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "metadata" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&acquire": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_AcquireLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseDuration" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "The Acquire operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "acquire" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&release": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ReleaseLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The Release operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "release" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&change": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ChangeLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdRequired" + }, + { + "$ref": "#/parameters/ProposedLeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "The Change operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "change" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=lease&break": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_BreakLease", + "description": "[Update] The Lease File operation establishes and manages a lock on a file for write and delete operations", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "The Break operation completed successfully.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value that you can use to perform operations conditionally. If the request version is 2011-08-18 or newer, the ETag value will be in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the last-modified time of the file." + }, + "x-ms-lease-id": { + "x-ms-client-name": "LeaseId", + "type": "string", + "description": "Uniquely identifies a file's lease" + }, + "x-ms-client-request-id": { + "x-ms-client-name": "ClientRequestId", + "type": "string", + "description": "If a client request id header is sent in the request, this header will be present in the response with the same value." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "UTC date/time value generated by the service that indicates the time at which the response was initiated" + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "lease" + ] + }, + { + "name": "x-ms-lease-action", + "x-ms-client-name": "action", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "break" + ], + "x-ms-enum": { + "name": "LeaseAction", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "description": "Describes what lease action to take." + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=range": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_UploadRange", + "description": "Upload a range of bytes to a file.", + "consumes": [ + "application/octet-stream" + ], + "parameters": [ + { + "$ref": "#/parameters/OptionalBody" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "description": "Specifies the range of bytes to be written. Both the start and end of the range must be specified. For an update operation, the range can be up to 4 MB in size. For a clear operation, the range can be up to the value of the file's full size. The File service accepts only a single byte range for the Range and 'x-ms-range' headers, and the byte range must be specified in the following format: bytes=startByte-endByte.", + "required": true, + "type": "string" + }, + { + "name": "x-ms-write", + "x-ms-client-name": "FileRangeWrite", + "in": "header", + "description": "Specify one of the following options: - Update: Writes the bytes specified by the request body into the specified range. The Range and Content-Length headers must match to perform the update. - Clear: Clears the specified range and releases the space used in storage for that range. To clear a range, set the Content-Length header to zero, and set the Range header to a value that indicates the range to clear, up to maximum file size.", + "required": true, + "type": "string", + "enum": [ + "update", + "clear" + ], + "default": "update", + "x-ms-enum": { + "name": "FileRangeWriteType", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/ContentMD5" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/FileLastWriteTimeMode" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "201": { + "description": "Success (Created).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "Content-MD5": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "range" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=range&fromURL": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_UploadRangeFromURL", + "description": "Upload a range of bytes to a file where the contents are read from a URL.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/TargetRange" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/SourceRange" + }, + { + "$ref": "#/parameters/FileRangeWriteFromUrl" + }, + { + "$ref": "#/parameters/ContentLength" + }, + { + "$ref": "#/parameters/SourceContentCrc64" + }, + { + "$ref": "#/parameters/SourceIfMatchCrc64" + }, + { + "$ref": "#/parameters/SourceIfNoneMatchCrc64" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/CopySourceAuthorization" + }, + { + "$ref": "#/parameters/FileLastWriteTimeMode" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + } + ], + "responses": { + "201": { + "description": "Success (Created).", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the directory was last modified. Any operation that modifies the share or its properties or metadata updates the last modified time. Operations on files do not affect the last modified time of the share." + }, + "x-ms-content-crc64": { + "type": "string", + "format": "byte", + "description": "This header is returned so that the client can check for message content integrity. The value of this header is computed by the File service; it is not necessarily the same value as may have been specified in the request headers." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "range" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=rangelist": { + "get": { + "tags": [ + "file" + ], + "operationId": "File_GetRangeList", + "description": "Returns the list of valid ranges for a file.", + "parameters": [ + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/PrevShareSnapshot" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "description": "Specifies the range of bytes over which to list ranges, inclusively.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "The date/time that the file was last modified. Any operation that modifies the file, including an update of the file's metadata or properties, changes the file's last modified time." + }, + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "x-ms-content-length": { + "x-ms-client-name": "FileContentLength", + "type": "integer", + "format": "int64", + "description": "The size of the file in bytes." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ShareFileRangeList" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rangelist" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=copy": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_StartCopy", + "description": "Copies a blob or file to a destination file within the storage account.", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/CopySource" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/FileCopyPermissionCopyMode" + }, + { + "$ref": "#/parameters/FileCopyIgnoreReadOnly" + }, + { + "$ref": "#/parameters/FileCopyFileAttributes" + }, + { + "$ref": "#/parameters/FileCopyFileCreationTime" + }, + { + "$ref": "#/parameters/FileCopyFileLastWriteTime" + }, + { + "$ref": "#/parameters/FileCopyFileChangeTime" + }, + { + "$ref": "#/parameters/FileCopySetArchiveAttribute" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "202": { + "description": "The copy file has been accepted with the specified copy status.", + "headers": { + "ETag": { + "type": "string", + "description": "If the copy is completed, contains the ETag of the destination file. If the copy is not complete, contains the ETag of the empty file created at the start of the copy." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date/time that the copy operation to the destination file completed." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-copy-id": { + "x-ms-client-name": "CopyId", + "type": "string", + "description": "String identifier for this copy operation. Use with Get File or Get File Properties to check the status of this copy operation, or pass to Abort Copy File to abort a pending copy." + }, + "x-ms-copy-status": { + "x-ms-client-name": "CopyStatus", + "description": "State of the copy operation identified by x-ms-copy-id.", + "type": "string", + "enum": [ + "pending", + "success", + "aborted", + "failed" + ], + "x-ms-enum": { + "name": "CopyStatusType", + "modelAsString": false + } + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=copy©id": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_AbortCopy", + "description": "Aborts a pending Copy File operation, and leaves a destination file with zero length and full metadata.", + "parameters": [ + { + "$ref": "#/parameters/CopyId" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/CopyActionAbort" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/LeaseIdOptional" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "204": { + "description": "The delete request was accepted and the file will be deleted.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "copy" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=listhandles": { + "get": { + "tags": [ + "file" + ], + "operationId": "File_ListHandles", + "description": "Lists handles for file", + "parameters": [ + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/MaxResults" + }, + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "Content-Type": { + "type": "string", + "description": "Specifies the format in which the results are returned. Currently this value is 'application/xml'." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + } + }, + "schema": { + "$ref": "#/definitions/ListHandlesResponse" + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "listhandles" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=forceclosehandles": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_ForceCloseHandles", + "description": "Closes all handles open for given file", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/Marker" + }, + { + "$ref": "#/parameters/ShareSnapshot" + }, + { + "$ref": "#/parameters/HandleId" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-marker": { + "x-ms-client-name": "marker", + "type": "string", + "description": "A string describing next handle to be closed. It is returned when more handles need to be closed to complete the request." + }, + "x-ms-number-of-handles-closed": { + "x-ms-client-name": "numberOfHandlesClosed", + "type": "integer", + "description": "Contains count of number of handles closed." + }, + "x-ms-number-of-handles-failed": { + "x-ms-client-name": "numberOfHandlesFailedToClose", + "type": "integer", + "description": "Contains count of number of handles that failed to close." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "forceclosehandles" + ] + } + ] + }, + "/{shareName}/{directory}/{fileName}?comp=rename": { + "put": { + "tags": [ + "file" + ], + "operationId": "File_Rename", + "description": "Renames a file", + "parameters": [ + { + "$ref": "#/parameters/Timeout" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/RenameSource" + }, + { + "$ref": "#/parameters/RenameReplaceIfExists" + }, + { + "$ref": "#/parameters/RenameIgnoreReadOnly" + }, + { + "$ref": "#/parameters/SourceLeaseId" + }, + { + "$ref": "#/parameters/DestinationLeaseId" + }, + { + "$ref": "#/parameters/FileCopyFileAttributes" + }, + { + "$ref": "#/parameters/FileCopyFileCreationTime" + }, + { + "$ref": "#/parameters/FileCopyFileLastWriteTime" + }, + { + "$ref": "#/parameters/FileCopyFileChangeTime" + }, + { + "$ref": "#/parameters/FilePermission" + }, + { + "$ref": "#/parameters/FilePermissionKey" + }, + { + "$ref": "#/parameters/Metadata" + }, + { + "$ref": "#/parameters/FileContentType" + }, + { + "$ref": "#/parameters/AllowTrailingDot" + }, + { + "$ref": "#/parameters/SourceAllowTrailingDot" + }, + { + "$ref": "#/parameters/FileRequestIntent" + } + ], + "responses": { + "200": { + "description": "Success.", + "headers": { + "ETag": { + "type": "string", + "description": "The ETag contains a value which represents the version of the file, in quotes." + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Returns the date and time the share was last modified. Any operation that modifies the directory or its properties updates the last modified time. Operations on files do not affect the last modified time of the directory." + }, + "x-ms-request-id": { + "x-ms-client-name": "RequestId", + "type": "string", + "description": "This header uniquely identifies the request that was made and can be used for troubleshooting the request." + }, + "x-ms-version": { + "x-ms-client-name": "Version", + "type": "string", + "description": "Indicates the version of the File service used to execute the request." + }, + "Date": { + "type": "string", + "format": "date-time-rfc1123", + "description": "A UTC date/time value generated by the service that indicates the time at which the response was initiated." + }, + "x-ms-request-server-encrypted": { + "x-ms-client-name": "IsServerEncrypted", + "type": "boolean", + "description": "The value of this header is set to true if the contents of the request are successfully encrypted using the specified algorithm, and false otherwise." + }, + "x-ms-file-permission-key": { + "x-ms-client-name": "FilePermissionKey", + "type": "string", + "description": "Key of the permission set for the file." + }, + "x-ms-file-attributes": { + "x-ms-client-name": "FileAttributes", + "type": "string", + "description": "Attributes set for the file." + }, + "x-ms-file-creation-time": { + "x-ms-client-name": "FileCreationTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Creation time for the file." + }, + "x-ms-file-last-write-time": { + "x-ms-client-name": "FileLastWriteTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Last write time for the file." + }, + "x-ms-file-change-time": { + "x-ms-client-name": "FileChangeTime", + "type": "string", + "format": "date-time-rfc1123", + "description": "Change time for the file." + }, + "x-ms-file-id": { + "x-ms-client-name": "FileId", + "type": "string", + "description": "The fileId of the file." + }, + "x-ms-file-parent-id": { + "x-ms-client-name": "FileParentId", + "type": "string", + "description": "The parent fileId of the directory." + } + } + }, + "default": { + "description": "Failure", + "headers": { + "x-ms-error-code": { + "x-ms-client-name": "ErrorCode", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/StorageError" + } + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ShareName" + }, + { + "$ref": "#/parameters/DirectoryPath" + }, + { + "$ref": "#/parameters/FilePath" + }, + { + "name": "comp", + "description": "comp", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "rename" + ] + } + ] + } + }, + "definitions": { + "AccessRight": { + "description": "Access rights of the access policy.", + "type": "string", + "enum": [ + "Read", + "Write", + "Delete" + ], + "x-ms-enum": { + "name": "AccessRight", + "modelAsString": false + } + }, + "AccessPolicy": { + "description": "An Access policy.", + "type": "object", + "properties": { + "Start": { + "description": "The date-time the policy is active.", + "type": "string", + "format": "date-time" + }, + "Expiry": { + "description": "The date-time the policy expires.", + "type": "string", + "format": "date-time" + }, + "Permission": { + "description": "The permissions for the ACL policy.", + "type": "string" + } + } + }, + "CorsRule": { + "description": "CORS is an HTTP feature that enables a web application running under one domain to access resources in another domain. Web browsers implement a security restriction known as same-origin policy that prevents a web page from calling APIs in a different domain; CORS provides a secure way to allow one domain (the origin domain) to call APIs in another domain.", + "type": "object", + "required": [ + "AllowedOrigins", + "AllowedMethods", + "AllowedHeaders", + "ExposedHeaders", + "MaxAgeInSeconds" + ], + "properties": { + "AllowedOrigins": { + "description": "The origin domains that are permitted to make a request against the storage service via CORS. The origin domain is the domain from which the request originates. Note that the origin must be an exact case-sensitive match with the origin that the user age sends to the service. You can also use the wildcard character '*' to allow all origin domains to make requests via CORS.", + "type": "string" + }, + "AllowedMethods": { + "description": "The methods (HTTP request verbs) that the origin domain may use for a CORS request. (comma separated)", + "type": "string" + }, + "AllowedHeaders": { + "description": "The request headers that the origin domain may specify on the CORS request.", + "type": "string" + }, + "ExposedHeaders": { + "description": "The response headers that may be sent in the response to the CORS request and exposed by the browser to the request issuer.", + "type": "string" + }, + "MaxAgeInSeconds": { + "description": "The maximum amount time that a browser should cache the preflight OPTIONS request.", + "type": "integer", + "minimum": 0 + } + } + }, + "ErrorCode": { + "description": "Error codes returned by the service", + "type": "string", + "enum": [ + "AccountAlreadyExists", + "AccountBeingCreated", + "AccountIsDisabled", + "AuthenticationFailed", + "AuthorizationFailure", + "ConditionHeadersNotSupported", + "ConditionNotMet", + "EmptyMetadataKey", + "InsufficientAccountPermissions", + "InternalError", + "InvalidAuthenticationInfo", + "InvalidHeaderValue", + "InvalidHttpVerb", + "InvalidInput", + "InvalidMd5", + "InvalidMetadata", + "InvalidQueryParameterValue", + "InvalidRange", + "InvalidResourceName", + "InvalidUri", + "InvalidXmlDocument", + "InvalidXmlNodeValue", + "Md5Mismatch", + "MetadataTooLarge", + "MissingContentLengthHeader", + "MissingRequiredQueryParameter", + "MissingRequiredHeader", + "MissingRequiredXmlNode", + "MultipleConditionHeadersNotSupported", + "OperationTimedOut", + "OutOfRangeInput", + "OutOfRangeQueryParameterValue", + "RequestBodyTooLarge", + "ResourceTypeMismatch", + "RequestUrlFailedToParse", + "ResourceAlreadyExists", + "ResourceNotFound", + "ServerBusy", + "UnsupportedHeader", + "UnsupportedXmlNode", + "UnsupportedQueryParameter", + "UnsupportedHttpVerb", + "CannotDeleteFileOrDirectory", + "ClientCacheFlushDelay", + "DeletePending", + "DirectoryNotEmpty", + "FileLockConflict", + "InvalidFileOrDirectoryPathName", + "ParentNotFound", + "ReadOnlyAttribute", + "ShareAlreadyExists", + "ShareBeingDeleted", + "ShareDisabled", + "ShareNotFound", + "SharingViolation", + "ShareSnapshotInProgress", + "ShareSnapshotCountExceeded", + "ShareSnapshotOperationNotSupported", + "ShareHasSnapshots", + "ContainerQuotaDowngradeNotAllowed", + "AuthorizationSourceIPMismatch", + "AuthorizationProtocolMismatch", + "AuthorizationPermissionMismatch", + "AuthorizationServiceMismatch", + "AuthorizationResourceTypeMismatch", + "FeatureVersionMismatch" + ], + "x-ms-enum": { + "name": "StorageErrorCode", + "modelAsString": true + } + }, + "FilesAndDirectoriesListSegment": { + "description": "Abstract for entries that can be listed from Directory.", + "type": "object", + "required": [ + "DirectoryItems", + "FileItems" + ], + "properties": { + "DirectoryItems": { + "type": "array", + "items": { + "$ref": "#/definitions/DirectoryItem" + } + }, + "FileItems": { + "type": "array", + "items": { + "$ref": "#/definitions/FileItem" + } + } + }, + "xml": { + "name": "Entries" + } + }, + "DirectoryItem": { + "xml": { + "name": "Directory" + }, + "description": "A listed directory item.", + "type": "object", + "required": [ + "Name" + ], + "properties": { + "Name": { + "$ref": "#/definitions/StringEncoded" + }, + "FileId": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/FileProperty" + }, + "Attributes": { + "type": "string" + }, + "PermissionKey": { + "type": "string" + } + } + }, + "FileItem": { + "xml": { + "name": "File" + }, + "description": "A listed file item.", + "type": "object", + "required": [ + "Name", + "Properties" + ], + "properties": { + "Name": { + "$ref": "#/definitions/StringEncoded" + }, + "FileId": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/FileProperty" + }, + "Attributes": { + "type": "string" + }, + "PermissionKey": { + "type": "string" + } + } + }, + "StringEncoded": { + "type": "object", + "properties": { + "Encoded": { + "xml": { + "name": "Encoded", + "attribute": true + }, + "type": "boolean" + }, + "content": { + "xml": { + "x-ms-text": true + }, + "type": "string" + } + } + }, + "FileProperty": { + "description": "File properties.", + "type": "object", + "required": [ + "Content-Length" + ], + "properties": { + "Content-Length": { + "description": "Content length of the file. This value may not be up-to-date since an SMB client may have modified the file locally. The value of Content-Length may not reflect that fact until the handle is closed or the op-lock is broken. To retrieve current property values, call Get File Properties.", + "type": "integer", + "format": "int64" + }, + "CreationTime": { + "type": "string", + "format": "date-time" + }, + "LastAccessTime": { + "type": "string", + "format": "date-time" + }, + "LastWriteTime": { + "type": "string", + "format": "date-time" + }, + "ChangeTime": { + "type": "string", + "format": "date-time" + }, + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + } + } + }, + "HandleItem": { + "xml": { + "name": "Handle" + }, + "description": "A listed Azure Storage handle item.", + "type": "object", + "required": [ + "HandleId", + "Path", + "FileId", + "SessionId", + "ClientIp", + "OpenTime" + ], + "properties": { + "HandleId": { + "type": "string", + "description": "XSMB service handle ID" + }, + "Path": { + "$ref": "#/definitions/StringEncoded" + }, + "FileId": { + "type": "string", + "description": "FileId uniquely identifies the file or directory." + }, + "ParentId": { + "type": "string", + "description": "ParentId uniquely identifies the parent directory of the object." + }, + "SessionId": { + "type": "string", + "description": "SMB session ID in context of which the file handle was opened" + }, + "ClientIp": { + "type": "string", + "description": "Client IP that opened the handle" + }, + "OpenTime": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Time when the session that previously opened the handle has last been reconnected. (UTC)" + }, + "LastReconnectTime": { + "type": "string", + "format": "date-time-rfc1123", + "description": "Time handle was last connected to (UTC)" + }, + "AccessRightList": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessRight" + }, + "xml": { + "wrapped": true + } + } + } + }, + "LeaseDuration": { + "xml": { + "name": "LeaseDuration" + }, + "description": "When a share is leased, specifies whether the lease is of infinite or fixed duration.", + "type": "string", + "enum": [ + "infinite", + "fixed" + ], + "x-ms-enum": { + "name": "LeaseDurationType", + "modelAsString": false + } + }, + "LeaseState": { + "xml": { + "name": "LeaseState" + }, + "description": "Lease state of the share.", + "type": "string", + "enum": [ + "available", + "leased", + "expired", + "breaking", + "broken" + ], + "x-ms-enum": { + "name": "LeaseStateType", + "modelAsString": false + } + }, + "LeaseStatus": { + "xml": { + "name": "LeaseStatus" + }, + "description": "The current lease status of the share.", + "type": "string", + "enum": [ + "locked", + "unlocked" + ], + "x-ms-enum": { + "name": "LeaseStatusType", + "modelAsString": false + } + }, + "ListFilesAndDirectoriesSegmentResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of directories and files.", + "type": "object", + "required": [ + "ServiceEndpoint", + "ShareName", + "DirectoryPath", + "Prefix", + "NextMarker", + "Segment" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ShareName": { + "type": "string", + "xml": { + "attribute": true + } + }, + "ShareSnapshot": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Encoded": { + "type": "boolean", + "xml": { + "attribute": true + } + }, + "DirectoryPath": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "$ref": "#/definitions/StringEncoded" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "Segment": { + "$ref": "#/definitions/FilesAndDirectoriesListSegment" + }, + "NextMarker": { + "type": "string" + }, + "DirectoryId": { + "type": "string" + } + } + }, + "ListHandlesResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of handles.", + "type": "object", + "required": [ + "NextMarker" + ], + "properties": { + "HandleList": { + "type": "array", + "items": { + "$ref": "#/definitions/HandleItem" + }, + "xml": { + "name": "Entries", + "wrapped": true + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "ListSharesResponse": { + "xml": { + "name": "EnumerationResults" + }, + "description": "An enumeration of shares.", + "type": "object", + "required": [ + "ServiceEndpoint", + "NextMarker" + ], + "properties": { + "ServiceEndpoint": { + "type": "string", + "xml": { + "attribute": true + } + }, + "Prefix": { + "type": "string" + }, + "Marker": { + "type": "string" + }, + "MaxResults": { + "type": "integer" + }, + "ShareItems": { + "type": "array", + "items": { + "$ref": "#/definitions/ShareItemInternal" + }, + "xml": { + "name": "Shares", + "wrapped": true + } + }, + "NextMarker": { + "type": "string" + } + } + }, + "Metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "Metrics": { + "description": "Storage Analytics metrics for file service.", + "required": [ + "Version", + "Enabled" + ], + "properties": { + "Version": { + "description": "The version of Storage Analytics to configure.", + "type": "string" + }, + "Enabled": { + "description": "Indicates whether metrics are enabled for the File service.", + "type": "boolean" + }, + "IncludeAPIs": { + "description": "Indicates whether metrics should generate summary statistics for called API operations.", + "type": "boolean" + }, + "RetentionPolicy": { + "$ref": "#/definitions/RetentionPolicy" + } + } + }, + "SmbMultichannel": { + "description": "Settings for SMB multichannel", + "type": "object", + "properties": { + "Enabled": { + "type": "boolean", + "description": "If SMB multichannel is enabled." + } + }, + "xml": { + "name": "Multichannel" + } + }, + "FileRange": { + "description": "An Azure Storage file range.", + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "description": "Start of the range." + }, + "End": { + "type": "integer", + "format": "int64", + "description": "End of the range." + } + }, + "xml": { + "name": "Range" + } + }, + "ClearRange": { + "type": "object", + "required": [ + "Start", + "End" + ], + "properties": { + "Start": { + "type": "integer", + "format": "int64", + "xml": { + "name": "Start" + } + }, + "End": { + "type": "integer", + "format": "int64", + "xml": { + "name": "End" + } + } + }, + "xml": { + "name": "ClearRange" + } + }, + "ShareProtocolSettings": { + "description": "Protocol settings", + "type": "object", + "xml": { + "name": "ProtocolSettings" + }, + "properties": { + "Smb": { + "description": "Settings for SMB protocol.", + "$ref": "#/definitions/ShareSmbSettings" + } + } + }, + "ShareFileRangeList": { + "description": "The list of file ranges", + "type": "object", + "properties": { + "Ranges": { + "type": "array", + "items": { + "$ref": "#/definitions/FileRange" + } + }, + "ClearRanges": { + "type": "array", + "items": { + "$ref": "#/definitions/ClearRange" + } + } + } + }, + "StorageError": { + "type": "object", + "properties": { + "Message": { + "type": "string" + } + } + }, + "RetentionPolicy": { + "description": "The retention policy.", + "type": "object", + "required": [ + "Enabled" + ], + "properties": { + "Enabled": { + "description": "Indicates whether a retention policy is enabled for the File service. If false, metrics data is retained, and the user is responsible for deleting it.", + "type": "boolean" + }, + "Days": { + "description": "Indicates the number of days that metrics data should be retained. All data older than this value will be deleted. Metrics data is deleted on a best-effort basis after the retention period expires.", + "type": "integer", + "minimum": 1, + "maximum": 365 + } + } + }, + "ShareItemInternal": { + "xml": { + "name": "Share" + }, + "description": "A listed Azure Storage share item.", + "type": "object", + "required": [ + "Name", + "Properties" + ], + "properties": { + "Name": { + "type": "string" + }, + "Snapshot": { + "type": "string" + }, + "Deleted": { + "type": "boolean" + }, + "Version": { + "type": "string" + }, + "Properties": { + "$ref": "#/definitions/SharePropertiesInternal" + }, + "Metadata": { + "$ref": "#/definitions/Metadata" + } + } + }, + "SharePropertiesInternal": { + "description": "Properties of a share.", + "type": "object", + "required": [ + "Last-Modified", + "Etag", + "Quota" + ], + "properties": { + "Last-Modified": { + "type": "string", + "format": "date-time-rfc1123" + }, + "Etag": { + "type": "string" + }, + "Quota": { + "type": "integer" + }, + "ProvisionedIops": { + "type": "integer" + }, + "ProvisionedIngressMBps": { + "type": "integer" + }, + "ProvisionedEgressMBps": { + "type": "integer" + }, + "ProvisionedBandwidthMiBps": { + "type": "integer" + }, + "NextAllowedQuotaDowngradeTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "DeletedTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "RemainingRetentionDays": { + "type": "integer" + }, + "AccessTier": { + "type": "string" + }, + "AccessTierChangeTime": { + "type": "string", + "format": "date-time-rfc1123" + }, + "AccessTierTransitionState": { + "type": "string" + }, + "LeaseStatus": { + "$ref": "#/definitions/LeaseStatus" + }, + "LeaseState": { + "$ref": "#/definitions/LeaseState" + }, + "LeaseDuration": { + "$ref": "#/definitions/LeaseDuration" + }, + "EnabledProtocols": { + "$ref": "#/definitions/ShareEnabledProtocols" + }, + "RootSquash": { + "$ref": "#/definitions/ShareRootSquash" + } + } + }, + "ShareStats": { + "description": "Stats for the share.", + "type": "object", + "required": [ + "ShareUsageBytes" + ], + "properties": { + "ShareUsageBytes": { + "description": "The approximate size of the data stored in bytes. Note that this value may not include all recently created or recently resized files.", + "type": "integer" + } + } + }, + "SignedIdentifier": { + "description": "Signed identifier.", + "type": "object", + "required": [ + "Id" + ], + "properties": { + "Id": { + "type": "string", + "description": "A unique id." + }, + "AccessPolicy": { + "description": "The access policy.", + "$ref": "#/definitions/AccessPolicy" + } + } + }, + "SignedIdentifiers": { + "description": "A collection of signed identifiers.", + "type": "array", + "items": { + "$ref": "#/definitions/SignedIdentifier", + "xml": { + "name": "SignedIdentifier" + } + }, + "xml": { + "wrapped": true, + "name": "SignedIdentifiers" + } + }, + "ShareSmbSettings": { + "description": "Settings for SMB protocol.", + "type": "object", + "xml": { + "name": "SMB" + }, + "properties": { + "Multichannel": { + "description": "Settings for SMB Multichannel.", + "$ref": "#/definitions/SmbMultichannel" + } + } + }, + "StorageServiceProperties": { + "description": "Storage service properties.", + "type": "object", + "properties": { + "HourMetrics": { + "description": "A summary of request statistics grouped by API in hourly aggregates for files.", + "$ref": "#/definitions/Metrics" + }, + "MinuteMetrics": { + "description": "A summary of request statistics grouped by API in minute aggregates for files.", + "$ref": "#/definitions/Metrics" + }, + "Cors": { + "description": "The set of CORS rules.", + "type": "array", + "items": { + "$ref": "#/definitions/CorsRule" + }, + "xml": { + "wrapped": true + } + }, + "Protocol": { + "description": "Protocol settings", + "$ref": "#/definitions/ShareProtocolSettings" + } + } + }, + "SharePermission": { + "description": "A permission (a security descriptor) at the share level.", + "type": "object", + "required": [ + "permission" + ], + "properties": { + "permission": { + "type": "string", + "description": "The permission in the Security Descriptor Definition Language (SDDL)." + } + } + }, + "ShareEnabledProtocols": { + "type": "string" + }, + "ShareRootSquash": { + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + } + } + }, + "parameters": { + "AccessTierOptional": { + "name": "x-ms-access-tier", + "x-ms-client-name": "accessTier", + "in": "header", + "description": "Specifies the access tier of the share.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "enum": [ + "TransactionOptimized", + "Hot", + "Cool" + ], + "x-ms-enum": { + "name": "ShareAccessTier", + "modelAsString": true + } + }, + "ApiVersionParameter": { + "name": "x-ms-version", + "x-ms-client-name": "version", + "x-ms-parameter-location": "client", + "in": "header", + "description": "Specifies the version of the operation to use for this request.", + "required": true, + "type": "string", + "enum": [ + "2023-01-03" + ] + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "requestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Provides a client-generated, opaque value with a 1 KB character limit that is recorded in the analytics logs when storage analytics logging is enabled." + }, + "ContentLength": { + "name": "Content-Length", + "x-ms-client-name": "contentLength", + "in": "header", + "description": "Specifies the number of bytes being transmitted in the request body. When the x-ms-write header is set to clear, the value of this header must be set to zero.", + "required": true, + "type": "integer", + "format": "int64", + "x-ms-parameter-location": "method" + }, + "ContentMD5": { + "name": "Content-MD5", + "x-ms-client-name": "contentMD5", + "in": "header", + "description": "An MD5 hash of the content. This hash is used to verify the integrity of the data during transport. When the Content-MD5 header is specified, the File service compares the hash of the content that has arrived with the header value that was sent. If the two hashes do not match, the operation will fail with error code 400 (Bad Request).", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method" + }, + "CopyActionAbort": { + "name": "x-ms-copy-action", + "x-ms-client-name": "copyActionAbortConstant", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "abort" + ], + "x-ms-parameter-location": "method", + "description": "Abort." + }, + "CopyId": { + "name": "copyid", + "x-ms-client-name": "copyId", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The copy identifier provided in the x-ms-copy-id header of the original Copy File operation." + }, + "CopySource": { + "name": "x-ms-copy-source", + "x-ms-client-name": "copySource", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the URL of the source file or blob, up to 2 KB in length. To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. A file in a share snapshot can also be specified as a copy source." + }, + "CopySourceAuthorization": { + "name": "x-ms-copy-source-authorization", + "x-ms-client-name": "copySourceAuthorization", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Only Bearer type is supported. Credentials should be a valid OAuth access token to copy source." + }, + "FileCopyPermissionCopyMode": { + "name": "x-ms-file-permission-copy-mode", + "x-ms-client-name": "filePermissionCopyMode", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "source", + "override" + ], + "x-ms-enum": { + "name": "PermissionCopyModeType", + "modelAsString": false + }, + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to copy file security descriptor from source file or to set it using the value which is defined by the header value of x-ms-file-permission or x-ms-file-permission-key." + }, + "FileCopyIgnoreReadOnly": { + "name": "x-ms-file-copy-ignore-readonly", + "x-ms-client-name": "ignoreReadOnly", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to overwrite the target file if it already exists and has read-only attribute set." + }, + "FileCopyFileAttributes": { + "name": "x-ms-file-attributes", + "x-ms-client-name": "fileAttributes", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file attributes from a source file(source) to a target file or a list of attributes to set on a target file." + }, + "FileCopyFileCreationTime": { + "name": "x-ms-file-creation-time", + "x-ms-client-name": "fileCreationTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file creation time from a source file(source) to a target file or a time value in ISO 8601 format to set as creation time on a target file." + }, + "FileCopyFileLastWriteTime": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "fileLastWriteTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file." + }, + "FileCopyFileChangeTime": { + "name": "x-ms-file-change-time", + "x-ms-client-name": "fileChangeTime", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies either the option to copy file last write time from a source file(source) to a target file or a time value in ISO 8601 format to set as last write time on a target file." + }, + "FileCopySetArchiveAttribute": { + "name": "x-ms-file-copy-set-archive", + "x-ms-client-name": "setArchiveAttribute", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "copy-file-smb-info" + }, + "description": "Specifies the option to set archive attribute on a target file. True means archive attribute will be set on a target file despite attribute overrides or a source file state." + }, + "DeletedShareName": { + "name": "x-ms-deleted-share-name", + "x-ms-client-name": "DeletedShareName", + "description": "Specifies the name of the previously-deleted share.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DirectoryPath": { + "name": "directory", + "in": "path", + "description": "The path of the target directory.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": false + }, + "FilePath": { + "name": "fileName", + "in": "path", + "description": "The path of the target file.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": false + }, + "ShareName": { + "name": "shareName", + "in": "path", + "description": "The name of the target share.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeletedShareVersion": { + "name": "x-ms-deleted-share-version", + "x-ms-client-name": "DeletedShareVersion", + "description": "Specifies the version of the previously-deleted share.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DeleteSnapshots": { + "name": "x-ms-delete-snapshots", + "x-ms-client-name": "deleteSnapshots", + "description": "Specifies the option include to delete the base share and all of its snapshots.", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "include", + "include-leased" + ], + "x-ms-enum": { + "name": "DeleteSnapshotsOptionType", + "modelAsString": false + }, + "x-ms-parameter-location": "method" + }, + "DestinationLeaseId": { + "name": "x-ms-destination-lease-id", + "x-ms-client-name": "destinationLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "destination-lease-access-conditions" + }, + "description": "Required if the destination file has an active infinite lease. The lease ID specified for this header must match the lease ID of the destination file. If the request does not include the lease ID or it is not valid, the operation fails with status code 412 (Precondition Failed). If this header is specified and the destination file does not currently have an active lease, the operation will also fail with status code 412 (Precondition Failed)." + }, + "FileAttributes": { + "name": "x-ms-file-attributes", + "x-ms-client-name": "FileAttributes", + "in": "header", + "description": "If specified, the provided file attributes shall be set. Default value: ‘Archive’ for file and ‘Directory’ for directory. ‘None’ can also be specified as default.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileCacheControl": { + "name": "x-ms-cache-control", + "x-ms-client-name": "fileCacheControl", + "description": "Sets the file's cache control. The File service stores this value but does not use or modify it.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentDisposition": { + "name": "x-ms-content-disposition", + "x-ms-client-name": "fileContentDisposition", + "description": "Sets the file's Content-Disposition header.", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentEncoding": { + "name": "x-ms-content-encoding", + "x-ms-client-name": "fileContentEncoding", + "in": "header", + "description": "Specifies which content encodings have been applied to the file.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentLanguage": { + "name": "x-ms-content-language", + "x-ms-client-name": "fileContentLanguage", + "in": "header", + "description": "Specifies the natural languages used by this resource.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentMD5": { + "name": "x-ms-content-md5", + "x-ms-client-name": "fileContentMD5", + "in": "header", + "description": "Sets the file's MD5 hash.", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileContentType": { + "name": "x-ms-content-type", + "x-ms-client-name": "fileContentType", + "in": "header", + "description": "Sets the MIME content type of the file. The default type is 'application/octet-stream'.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "file-HTTP-headers" + } + }, + "FileCreationTime": { + "name": "x-ms-file-creation-time", + "x-ms-client-name": "FileCreationTime", + "in": "header", + "description": "Creation time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FileLastWriteTime": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "FileLastWriteTime", + "in": "header", + "description": "Last write time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FileChangeTime": { + "name": "x-ms-file-change-time", + "x-ms-client-name": "FileChangeTime", + "in": "header", + "description": "Change time for the file/directory. Default value: Now.", + "required": false, + "type": "string", + "format": "date-time-rfc1123", + "x-ms-parameter-location": "method" + }, + "FileLastWriteTimeMode": { + "name": "x-ms-file-last-write-time", + "x-ms-client-name": "FileLastWrittenMode", + "in": "header", + "description": "If the file last write time should be preserved or overwritten", + "required": false, + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "Now", + "Preserve" + ], + "x-ms-enum": { + "name": "FileLastWrittenMode", + "modelAsString": false + } + }, + "FilePermission": { + "name": "x-ms-file-permission", + "x-ms-client-name": "FilePermission", + "in": "header", + "description": "If specified the permission (security descriptor) shall be set for the directory/file. This header can be used if Permission size is <= 8KB, else x-ms-file-permission-key header shall be used. Default value: Inherit. If SDDL is specified as input, it must have owner, group and dacl. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FilePermissionKey": { + "name": "x-ms-file-permission-key", + "x-ms-client-name": "FilePermissionKey", + "in": "header", + "description": "Key of the permission to be set for the directory/file. Note: Only one of the x-ms-file-permission or x-ms-file-permission-key should be specified.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FilePermissionKeyRequired": { + "name": "x-ms-file-permission-key", + "x-ms-client-name": "FilePermissionKey", + "in": "header", + "description": "Key of the permission to be set for the directory/file.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileRangeWriteFromUrl": { + "name": "x-ms-write", + "x-ms-parameter-location": "client", + "x-ms-client-name": "fileRangeWriteFromUrl", + "in": "header", + "description": "Only update is supported: - Update: Writes the bytes downloaded from the source url into the specified range.", + "required": true, + "type": "string", + "enum": [ + "update" + ], + "default": "update", + "x-ms-enum": { + "name": "FileRangeWriteFromUrlType", + "modelAsString": false + } + }, + "FileRequestIntent": { + "name": "x-ms-file-request-intent", + "x-ms-client-name": "fileRequestIntent", + "in": "header", + "description": "Valid value is backup", + "required": false, + "type": "string", + "enum": [ + "backup" + ], + "x-ms-enum": { + "name": "ShareTokenIntent", + "modelAsString": true + } + }, + "FileType": { + "name": "x-ms-type", + "x-ms-client-name": "fileTypeConstant", + "in": "header", + "required": true, + "description": "Dummy constant parameter, file type can only be file.", + "type": "string", + "enum": [ + "file" + ], + "x-ms-parameter-location": "method" + }, + "GetRangeContentMD5": { + "name": "x-ms-range-get-content-md5", + "x-ms-client-name": "rangeGetContentMD5", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "When this header is set to true and specified together with the Range header, the service returns the MD5 hash for the range, as long as the range is less than or equal to 4 MB in size." + }, + "HandleId": { + "name": "x-ms-handle-id", + "x-ms-client-name": "handleId", + "in": "header", + "description": "Specifies handle ID opened on the file or directory to be closed. Asterisk (‘*’) is a wildcard that specifies all handles.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LeaseBreakPeriod": { + "name": "x-ms-lease-break-period", + "x-ms-client-name": "breakPeriod", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "For a break operation, proposed duration the lease should continue before it is broken, in seconds, between 0 and 60. This break period is only used if it is shorter than the time remaining on the lease. If longer, the time remaining on the lease is used. A new lease will not be available before the break period has expired, but the lease may be held for longer than the break period. If this header does not appear with a break operation, a fixed-duration lease breaks after the remaining lease period elapses, and an infinite lease breaks immediately." + }, + "LeaseDuration": { + "name": "x-ms-lease-duration", + "x-ms-client-name": "duration", + "in": "header", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method", + "description": "Specifies the duration of the lease, in seconds, or negative one (-1) for a lease that never expires. A non-infinite lease can be between 15 and 60 seconds. A lease duration cannot be changed using renew or change." + }, + "LeaseIdOptional": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "lease-access-conditions" + }, + "description": "If specified, the operation only succeeds if the resource's lease is active and matches this ID." + }, + "LeaseIdRequired": { + "name": "x-ms-lease-id", + "x-ms-client-name": "leaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Specifies the current lease ID on the resource." + }, + "ListFilesInclude": { + "name": "include", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "Timestamps", + "Etag", + "Attributes", + "PermissionKey" + ], + "x-ms-enum": { + "name": "ListFilesIncludeType", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method" + }, + "ListFilesExtendedInfo": { + "name": "x-ms-file-extended-info", + "x-ms-client-name": "includeExtendedInfo", + "x-ms-parameter-location": "method", + "in": "header", + "type": "boolean", + "required": false, + "description": "Include extended information." + }, + "ListSharesInclude": { + "name": "include", + "in": "query", + "description": "Include this parameter to specify one or more datasets to include in the response.", + "required": false, + "type": "array", + "collectionFormat": "csv", + "items": { + "type": "string", + "enum": [ + "snapshots", + "metadata", + "deleted" + ], + "x-ms-enum": { + "name": "ListSharesIncludeType", + "modelAsString": false + } + }, + "x-ms-parameter-location": "method" + }, + "Marker": { + "name": "marker", + "in": "query", + "description": "A string value that identifies the portion of the list to be returned with the next list operation. The operation returns a marker value within the response body if the list returned was not complete. The marker value may then be used in a subsequent call to request the next set of list items. The marker value is opaque to the client.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MaxResults": { + "name": "maxresults", + "in": "query", + "description": "Specifies the maximum number of entries to return. If the request does not specify maxresults, or specifies a value greater than 5,000, the server will return up to 5,000 items.", + "required": false, + "type": "integer", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "Metadata": { + "name": "x-ms-meta", + "x-ms-client-name": "metadata", + "in": "header", + "description": "A name-value pair to associate with a file storage object.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-header-collection-prefix": "x-ms-meta-" + }, + "OptionalBody": { + "name": "optionalbody", + "in": "body", + "description": "Initial data.", + "required": false, + "schema": { + "type": "object", + "format": "file" + }, + "x-ms-parameter-location": "method" + }, + "Prefix": { + "name": "prefix", + "in": "query", + "description": "Filters the results to return only entries whose name begins with the specified prefix.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrevShareSnapshot": { + "name": "prevsharesnapshot", + "in": "query", + "description": "The previous snapshot parameter is an opaque DateTime value that, when present, specifies the previous snapshot.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ProposedLeaseIdOptional": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "ProposedLeaseIdRequired": { + "name": "x-ms-proposed-lease-id", + "x-ms-client-name": "proposedLeaseId", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Proposed lease ID, in a GUID string format. The File service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats." + }, + "Range": { + "name": "x-ms-range", + "x-ms-client-name": "range", + "in": "header", + "description": "Return file data only from the specified byte range.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Recursive": { + "name": "x-ms-recursive", + "x-ms-client-name": "recursive", + "in": "header", + "description": "Specifies operation should apply to the directory specified in the URI, its files, its subdirectories and their files.", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "RenameIgnoreReadOnly": { + "name": "x-ms-file-rename-ignore-readonly", + "x-ms-client-name": "ignoreReadOnly", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Optional. A boolean value that specifies whether the ReadOnly attribute on a preexisting destination file should be respected. If true, the rename will succeed, otherwise, a previous file at the destination with the ReadOnly attribute set will cause the rename to fail." + }, + "RenameReplaceIfExists": { + "name": "x-ms-file-rename-replace-if-exists", + "x-ms-client-name": "replaceIfExists", + "in": "header", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method", + "description": "Optional. A boolean value for if the destination file already exists, whether this request will overwrite the file or not. If true, the rename will succeed and will overwrite the destination file. If not provided or if false and the destination file does exist, the request will not overwrite the destination file. If provided and the destination file doesn’t exist, the rename will succeed. Note: This value does not override the x-ms-file-copy-ignore-read-only header value." + }, + "RenameSource": { + "name": "x-ms-file-rename-source", + "x-ms-client-name": "renameSource", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Required. Specifies the URI-style path of the source file, up to 2 KB in length." + }, + "Url": { + "name": "url", + "x-ms-parameter-location": "client", + "in": "path", + "description": "The URL of the service account, share, directory or file that is the target of the desired operation.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + "ShareAcl": { + "name": "shareAcl", + "in": "body", + "description": "The ACL for the share.", + "schema": { + "$ref": "#/definitions/SignedIdentifiers" + }, + "x-ms-parameter-location": "method" + }, + "ShareQuota": { + "name": "x-ms-share-quota", + "x-ms-client-name": "quota", + "in": "header", + "description": "Specifies the maximum size of the share, in gigabytes.", + "required": false, + "type": "integer", + "minimum": 1, + "x-ms-parameter-location": "method" + }, + "ShareSnapshot": { + "name": "sharesnapshot", + "in": "query", + "description": "The snapshot parameter is an opaque DateTime value that, when present, specifies the share snapshot to query.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SourceContentCrc64": { + "name": "x-ms-source-content-crc64", + "x-ms-client-name": "sourceContentCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "description": "Specify the crc64 calculated for the range of bytes that must be read from the copy source." + }, + "SourceIfMatchCrc64": { + "name": "x-ms-source-if-match-crc64", + "x-ms-client-name": "sourceIfMatchCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify the crc64 value to operate only on range with a matching crc64 checksum." + }, + "SourceIfNoneMatchCrc64": { + "name": "x-ms-source-if-none-match-crc64", + "x-ms-client-name": "sourceIfNoneMatchCrc64", + "in": "header", + "required": false, + "type": "string", + "format": "byte", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-modified-access-conditions" + }, + "description": "Specify the crc64 value to operate only on range without a matching crc64 checksum." + }, + "SourceLeaseId": { + "name": "x-ms-source-lease-id", + "x-ms-client-name": "sourceLeaseId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "name": "source-lease-access-conditions" + }, + "description": "Required if the source file has an active infinite lease." + }, + "SourceRange": { + "name": "x-ms-source-range", + "x-ms-client-name": "sourceRange", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Bytes of source data in the specified range." + }, + "StorageServiceProperties": { + "name": "StorageServiceProperties", + "in": "body", + "description": "The StorageService properties.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageServiceProperties" + }, + "x-ms-parameter-location": "method" + }, + "TargetRange": { + "name": "x-ms-range", + "x-ms-client-name": "Range", + "in": "header", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Writes data to the specified byte range in the file." + }, + "Timeout": { + "name": "timeout", + "in": "query", + "description": "The timeout parameter is expressed in seconds. For more information, see Setting Timeouts for File Service Operations.", + "required": false, + "type": "integer", + "minimum": 0, + "x-ms-parameter-location": "method" + }, + "SharePermission": { + "name": "sharePermission", + "in": "body", + "description": "A permission (a security descriptor) at the share level.", + "required": true, + "schema": { + "$ref": "#/definitions/SharePermission" + }, + "x-ms-parameter-location": "method" + }, + "ShareEnabledProtocols": { + "name": "x-ms-enabled-protocols", + "description": "Protocols to enable on the share.", + "x-ms-client-name": "enabledProtocols", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ShareRootSquash": { + "name": "x-ms-root-squash", + "description": "Root squash to set on the share. Only valid for NFS shares.", + "x-ms-client-name": "rootSquash", + "in": "header", + "required": false, + "type": "string", + "enum": [ + "NoRootSquash", + "RootSquash", + "AllSquash" + ], + "x-ms-enum": { + "name": "ShareRootSquash", + "modelAsString": false + }, + "x-ms-parameter-location": "method" + }, + "AllowTrailingDot": { + "name": "x-ms-allow-trailing-dot", + "description": "If true, the trailing dot will not be trimmed from the target URI.", + "x-ms-client-name": "allowTrailingDot", + "in": "header", + "required": false, + "type": "boolean" + }, + "SourceAllowTrailingDot": { + "name": "x-ms-source-allow-trailing-dot", + "description": "If true, the trailing dot will not be trimmed from the source URI.", + "x-ms-client-name": "allowSourceTrailingDot", + "in": "header", + "required": false, + "type": "boolean" + } + } +} diff --git a/specification/storage/data-plane/Microsoft.FileStorage/readme.md b/specification/storage/data-plane/Microsoft.FileStorage/readme.md index 1d50a68ba0c6..3adb36a62239 100644 --- a/specification/storage/data-plane/Microsoft.FileStorage/readme.md +++ b/specification/storage/data-plane/Microsoft.FileStorage/readme.md @@ -25,7 +25,7 @@ These are the global settings for the FileStorage API. ``` yaml openapi-type: data-plane -tag: package-2022-11 +tag: package-2023-01 use-internal-constructors: true add-credentials: true ``` @@ -84,6 +84,15 @@ input-file: - preview/2022-11-02/file.json ``` +### Tag: package-2023-01 + +These settings apply only when `--tag=package-2023-01` is specified on the command line. + +``` yaml $(tag) == 'package-2023-01' +input-file: +- preview/2023-01-03/file.json +``` + ### Suppression ``` yaml directive: From 8e20af0463637085b47a018ec9c8372a2242bdac Mon Sep 17 00:00:00 2001 From: malpaniHMC Date: Tue, 2 May 2023 13:19:41 -0700 Subject: [PATCH 06/79] Traffic Controller v2023-05-01-preview (#23614) * init new version * fixing validation errors * rename cadl file * fixing readme --- ...cController.cadl => TrafficController.tsp} | 61 +- .../cadl/examples/AssociationDelete.json | 2 +- .../cadl/examples/AssociationGet.json | 2 +- .../cadl/examples/AssociationPatch.json | 2 +- .../cadl/examples/AssociationPut.json | 2 +- .../cadl/examples/AssociationsGet.json | 2 +- .../cadl/examples/FrontendDelete.json | 2 +- .../cadl/examples/FrontendGet.json | 8 +- .../cadl/examples/FrontendPatch.json | 18 +- .../cadl/examples/FrontendPut.json | 22 +- .../cadl/examples/FrontendsGet.json | 8 +- .../cadl/examples/OperationsList.json | 2 +- .../examples/TrafficControllerDelete.json | 2 +- .../cadl/examples/TrafficControllerGet.json | 2 +- .../cadl/examples/TrafficControllerPatch.json | 2 +- .../cadl/examples/TrafficControllerPut.json | 2 +- .../cadl/examples/TrafficControllersGet.json | 2 +- .../examples/TrafficControllersGetList.json | 2 +- .../2023-05-01-preview/TrafficController.json | 1373 +++++++++++++++++ .../resource-manager/readme.md | 14 +- 20 files changed, 1433 insertions(+), 97 deletions(-) rename specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/{TrafficController.cadl => TrafficController.tsp} (72%) create mode 100644 specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/TrafficController.cadl b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/TrafficController.tsp similarity index 72% rename from specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/TrafficController.cadl rename to specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/TrafficController.tsp index cabeea70a1d4..bea3fc5dd5bc 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/TrafficController.cadl +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/TrafficController.tsp @@ -1,26 +1,27 @@ -import "@cadl-lang/openapi"; -import "@cadl-lang/rest"; -import "@azure-tools/cadl-providerhub"; -import "@azure-tools/cadl-azure-core"; -import "@azure-tools/cadl-autorest"; -import "@azure-tools/cadl-azure-resource-manager"; +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-providerhub"; +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-azure-resource-manager"; @armProviderNamespace -@service({title:"TrafficController"}) -@service({version: "2022-10-01-preview"}) +@service({ + title: "TrafficController", + version: "2023-05-01-preview", +}) @doc("Traffic Controller Provider management API.") -@versionedDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) -@versionedDependency(Azure.Core.Versions.v1_0_Preview_1) +@useDependency(Azure.ResourceManager.Versions.v1_0_Preview_1) +@useDependency(Azure.Core.Versions.v1_0_Preview_1) namespace Microsoft.ServiceNetworking; -using Cadl.Http; -using Cadl.Rest; -using Cadl.Versioning; +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; using Azure.Core; using Azure.ResourceManager; - //----------------------- Frontends ----------------------- @doc("Frontend Subresource of Traffic Controller.") @parentResource(TrafficController) @@ -35,31 +36,15 @@ model Frontend is TrackedResource{ @doc("Frontend Properties.") model FrontendProperties { - @doc("Frontend Mode (Optional).") - mode?: FrontendMode; - @doc("Frontend IP Address Version (Optional).") - ipAddressVersion?: FrontendIPAddressVersion; - @doc("Frontend Public IP Address (Optional).") - publicIPAddress?: FrontendPropertiesIPAddress; + @visibility("read") + @doc("The Fully Qualified Domain Name of the DNS record associated to a Traffic Controller frontend.") + fqdn : string; + @visibility("read") @doc("Provisioning State of Traffic Controller Frontend Resource") provisioningState?: ProvisioningState; } -enum FrontendMode { - public -} -enum FrontendIPAddressVersion { - IPv4, - IPv6, -} - -@doc("Frontend IP Address.") -model FrontendPropertiesIPAddress { - @doc("IP Address.") - id: string; -} - //----------------------- Associations ----------------------- @doc("Association Subresource of Traffic Controller") @parentResource(TrafficController) @@ -111,10 +96,10 @@ model TrafficControllerProperties { configurationEndpoints?: string[]; @visibility("read") @doc("Frontends References List") - frontends? : ResourceID[]; + frontends? : ResourceId[]; @visibility("read") @doc("Associations References List") - associations? : ResourceID[]; + associations? : ResourceId[]; @visibility("read") @doc("The status of the last operation.") provisioningState?: ProvisioningState; @@ -132,7 +117,7 @@ enum ProvisioningState{ } @doc("Resource ID definition used by parent to reference child resources.") -model ResourceID{ +model ResourceId{ @doc("Resource ID of child resource.") id : string; } @@ -147,7 +132,7 @@ interface FrontendsInterface extends ResourceInstanceOperations{ +interface TrafficControllerInterface extends TrackedResourceOperations{ } interface Operations extends Azure.ResourceManager.Operations {} diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationDelete.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationDelete.json index 3d1769426ead..1828d1f1aa4f 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationDelete.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationDelete.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1", diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationGet.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationGet.json index c80059e638e1..7a61eb85fc28 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationGet.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationGet.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1", diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationPatch.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationPatch.json index 27c9219a467f..e3c4c25bb2f4 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationPatch.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationPatch.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1", diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationPut.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationPut.json index dfb1c9b41413..7cae6c94c2dc 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationPut.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationPut.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1", diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationsGet.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationsGet.json index 622ef9da9eca..be8f02adb581 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationsGet.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/AssociationsGet.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1" diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendDelete.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendDelete.json index b87ba7195ee0..7e53a06ae0a7 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendDelete.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendDelete.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1", diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendGet.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendGet.json index c4365e67b9d7..edb1a876bc81 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendGet.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendGet.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1", @@ -14,11 +14,7 @@ "type": "Microsoft.ServiceNetworking/trafficControllers/frontends", "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1/frontends/fe1", "properties": { - "mode": "public", - "ipAddressVersion": "IPv4", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIP-fe1" - }, + "fqdn": "test.net", "provisioningState": "Succeeded" } } diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendPatch.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendPatch.json index e13bcb656511..300b96911152 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendPatch.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendPatch.json @@ -1,19 +1,11 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1", "frontendName": "fe1", - "properties": { - "properties": { - "mode": "public", - "ipAddressVersion": "IPv4", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIP-fe1" - } - } - } + "properties": {} }, "responses": { "200": { @@ -23,11 +15,7 @@ "type": "Microsoft.ServiceNetworking/trafficControllers/frontends", "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1/frontends/fe1", "properties": { - "mode": "public", - "ipAddressVersion": "IPv4", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIP-fe1" - }, + "fqdn": "test.net", "provisioningState": "Succeeded" } } diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendPut.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendPut.json index 8dcd1f383ac8..5a4463d12cdb 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendPut.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendPut.json @@ -1,19 +1,13 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1", "frontendName": "fe1", "resource": { "location": "NorthCentralUS", - "properties": { - "mode": "public", - "ipAddressVersion": "IPv4", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIP-fe1" - } - } + "properties": {} } }, "responses": { @@ -24,11 +18,7 @@ "type": "Microsoft.ServiceNetworking/trafficControllers/frontends", "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1/frontends/fe1", "properties": { - "mode": "public", - "ipAddressVersion": "IPv4", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIP-fe1" - }, + "fqdn": "test.net", "provisioningState": "Succeeded" } } @@ -40,11 +30,7 @@ "type": "Microsoft.ServiceNetworking/trafficControllers/frontends", "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1/frontends/fe1", "properties": { - "mode": "public", - "ipAddressVersion": "IPv4", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIP-fe1" - }, + "fqdn": "test.net", "provisioningState": "Succeeded" } } diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendsGet.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendsGet.json index 500188fe1337..153b8a097fef 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendsGet.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/FrontendsGet.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1" @@ -15,11 +15,7 @@ "type": "Microsoft.ServiceNetworking/trafficControllers/frontends", "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ServiceNetworking/trafficControllers/tc1/frontends/fe1", "properties": { - "mode": "public", - "ipAddressVersion": "IPv4", - "publicIPAddress": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIP-fe1" - }, + "fqdn": "test.net", "provisioningState": "Succeeded" } } diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/OperationsList.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/OperationsList.json index 8a2720f60956..77b5a1c07a24 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/OperationsList.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/OperationsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview" + "api-version": "2023-05-01-preview" }, "responses": { "200": { diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerDelete.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerDelete.json index 0b7aac1c6366..dc92539ef6fe 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerDelete.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerDelete.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1" diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerGet.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerGet.json index ff4c0ce1808b..4a9d11c934a7 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerGet.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerGet.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1" diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerPatch.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerPatch.json index 7fff65d564d3..60c6248f2954 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerPatch.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerPatch.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1", diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerPut.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerPut.json index 141aaa1bc279..9e693a534023 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerPut.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllerPut.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1", "trafficControllerName": "tc1", diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllersGet.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllersGet.json index bf188210a4c3..541e1091dc71 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllersGet.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllersGet.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid", "resourceGroupName": "rg1" }, diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllersGetList.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllersGetList.json index 039ecba417c0..4c59585a5e65 100644 --- a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllersGetList.json +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/cadl/examples/TrafficControllersGetList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2022-10-01-preview", + "api-version": "2023-05-01-preview", "subscriptionId": "subid" }, "responses": { diff --git a/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json new file mode 100644 index 000000000000..7f4174b29403 --- /dev/null +++ b/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json @@ -0,0 +1,1373 @@ +{ + "swagger": "2.0", + "info": { + "title": "TrafficController", + "version": "2023-05-01-preview", + "description": "Traffic Controller 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": "AssociationsInterface" + }, + { + "name": "FrontendsInterface" + }, + { + "name": "TrafficControllerInterface" + }, + { + "name": "Operations" + } + ], + "paths": { + "/providers/Microsoft.ServiceNetworking/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "List the operations for the provider", + "x-ms-examples": { + "Get Operations List": { + "$ref": "../../cadl/examples/OperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceNetworking/trafficControllers": { + "get": { + "tags": [ + "TrafficControllerInterface" + ], + "operationId": "TrafficControllerInterface_ListBySubscription", + "description": "List TrafficController resources by subscription ID", + "x-ms-examples": { + "Get Traffic Controllers List": { + "$ref": "../../cadl/examples/TrafficControllersGetList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TrafficControllerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers": { + "get": { + "tags": [ + "TrafficControllerInterface" + ], + "operationId": "TrafficControllerInterface_ListByResourceGroup", + "description": "List TrafficController resources by resource group", + "x-ms-examples": { + "Get Traffic Controllers": { + "$ref": "../../cadl/examples/TrafficControllersGet.json" + } + }, + "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": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TrafficControllerListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}": { + "get": { + "tags": [ + "TrafficControllerInterface" + ], + "operationId": "TrafficControllerInterface_Get", + "description": "Get a TrafficController", + "x-ms-examples": { + "Get Traffic Controller": { + "$ref": "../../cadl/examples/TrafficControllerGet.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TrafficController" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "TrafficControllerInterface" + ], + "operationId": "TrafficControllerInterface_CreateOrUpdate", + "description": "Create a TrafficController", + "x-ms-examples": { + "Put Traffic Controller": { + "$ref": "../../cadl/examples/TrafficControllerPut.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/TrafficController" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TrafficController" + } + }, + "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" + } + }, + "schema": { + "$ref": "#/definitions/TrafficController" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "TrafficControllerInterface" + ], + "operationId": "TrafficControllerInterface_Update", + "description": "Update a TrafficController", + "x-ms-examples": { + "Patch Traffic Controller": { + "$ref": "../../cadl/examples/TrafficControllerPatch.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/TrafficControllerUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/TrafficController" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "TrafficControllerInterface" + ], + "operationId": "TrafficControllerInterface_Delete", + "description": "Delete a TrafficController", + "x-ms-examples": { + "Delete Traffic Controller": { + "$ref": "../../cadl/examples/TrafficControllerDelete.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion accepted.", + "headers": { + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + }, + "Retry-After": { + "description": "The Retry-After header can indicate how long the client should wait before polling the operation status.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations": { + "get": { + "tags": [ + "AssociationsInterface" + ], + "operationId": "AssociationsInterface_ListByTrafficController", + "description": "List Association resources by TrafficController", + "x-ms-examples": { + "Get Associations": { + "$ref": "../../cadl/examples/AssociationsGet.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/AssociationListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/associations/{associationName}": { + "get": { + "tags": [ + "AssociationsInterface" + ], + "operationId": "AssociationsInterface_Get", + "description": "Get a Association", + "x-ms-examples": { + "Get Association": { + "$ref": "../../cadl/examples/AssociationGet.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "associationName", + "in": "path", + "required": true, + "description": "Name of Association", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Association" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "AssociationsInterface" + ], + "operationId": "AssociationsInterface_CreateOrUpdate", + "description": "Create a Association", + "x-ms-examples": { + "Put Association": { + "$ref": "../../cadl/examples/AssociationPut.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "associationName", + "in": "path", + "required": true, + "description": "Name of Association", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/Association" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Association" + } + }, + "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" + } + }, + "schema": { + "$ref": "#/definitions/Association" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "AssociationsInterface" + ], + "operationId": "AssociationsInterface_Update", + "description": "Update a Association", + "x-ms-examples": { + "Update Association": { + "$ref": "../../cadl/examples/AssociationPatch.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "associationName", + "in": "path", + "required": true, + "description": "Name of Association", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/AssociationUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Association" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "AssociationsInterface" + ], + "operationId": "AssociationsInterface_Delete", + "description": "Delete a Association", + "x-ms-examples": { + "Delete Association": { + "$ref": "../../cadl/examples/AssociationDelete.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "associationName", + "in": "path", + "required": true, + "description": "Name of Association", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion 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" + }, + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends": { + "get": { + "tags": [ + "FrontendsInterface" + ], + "operationId": "FrontendsInterface_ListByTrafficController", + "description": "List Frontend resources by TrafficController", + "x-ms-examples": { + "Get Frontends": { + "$ref": "../../cadl/examples/FrontendsGet.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/FrontendListResult" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceNetworking/trafficControllers/{trafficControllerName}/frontends/{frontendName}": { + "get": { + "tags": [ + "FrontendsInterface" + ], + "operationId": "FrontendsInterface_Get", + "description": "Get a Frontend", + "x-ms-examples": { + "Get Frontend": { + "$ref": "../../cadl/examples/FrontendGet.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "frontendName", + "in": "path", + "required": true, + "description": "Frontends", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Frontend" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "FrontendsInterface" + ], + "operationId": "FrontendsInterface_CreateOrUpdate", + "description": "Create a Frontend", + "x-ms-examples": { + "Put Frontend": { + "$ref": "../../cadl/examples/FrontendPut.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "frontendName", + "in": "path", + "required": true, + "description": "Frontends", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "Resource create parameters.", + "schema": { + "$ref": "#/definitions/Frontend" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Frontend" + } + }, + "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" + } + }, + "schema": { + "$ref": "#/definitions/Frontend" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "FrontendsInterface" + ], + "operationId": "FrontendsInterface_Update", + "description": "Update a Frontend", + "x-ms-examples": { + "Update Frontend": { + "$ref": "../../cadl/examples/FrontendPatch.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "frontendName", + "in": "path", + "required": true, + "description": "Frontends", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "properties", + "in": "body", + "required": true, + "description": "The resource properties to be updated.", + "schema": { + "$ref": "#/definitions/FrontendUpdate" + } + } + ], + "responses": { + "200": { + "description": "ARM operation completed successfully.", + "schema": { + "$ref": "#/definitions/Frontend" + } + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "FrontendsInterface" + ], + "operationId": "FrontendsInterface_Delete", + "description": "Delete a Frontend", + "x-ms-examples": { + "Delete Frontend": { + "$ref": "../../cadl/examples/FrontendDelete.json" + } + }, + "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": "trafficControllerName", + "in": "path", + "required": true, + "description": "traffic controller name for path", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + }, + { + "name": "frontendName", + "in": "path", + "required": true, + "description": "Frontends", + "type": "string", + "pattern": "[A-Za-z0-9]+[A-Za-z0-9-_.]{0,62}[A-Za-z0-9_]+" + } + ], + "responses": { + "200": { + "description": "Resource deleted successfully." + }, + "202": { + "description": "Resource deletion 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" + }, + "Location": { + "description": "The Location header contains the URL where the status of the long running operation can be checked.", + "type": "string" + } + } + }, + "204": { + "description": "Resource deleted successfully." + }, + "default": { + "description": "An unexpected error response.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "Association": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AssociationProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "Association Subresource of Traffic Controller", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "AssociationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Association" + }, + "x-typespec-name": "Association[]", + "description": "The Association items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + } + }, + "description": "The response of a Association list operation.", + "required": [ + "value" + ] + }, + "AssociationProperties": { + "type": "object", + "properties": { + "associationType": { + "$ref": "#/definitions/AssociationType", + "description": "Association Type" + }, + "subnet": { + "$ref": "#/definitions/AssociationSubnet", + "description": "Association Subnet" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of Traffic Controller Association Resource", + "readOnly": true + } + }, + "description": "Association Properties.", + "required": [ + "associationType" + ] + }, + "AssociationSubnet": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Association ID." + } + }, + "description": "Association Subnet.", + "required": [ + "id" + ] + }, + "AssociationSubnetUpdate": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Association ID." + } + }, + "description": "Association Subnet." + }, + "AssociationType": { + "type": "string", + "enum": [ + "subnets" + ], + "x-ms-enum": { + "name": "AssociationType", + "modelAsString": true + } + }, + "AssociationUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-typespec-name": "Record", + "description": "Resource tags." + }, + "properties": { + "$ref": "#/definitions/AssociationUpdateProperties", + "x-ms-client-flatten": true + } + }, + "description": "The type used for update operations of the Association." + }, + "AssociationUpdateProperties": { + "type": "object", + "properties": { + "associationType": { + "$ref": "#/definitions/AssociationType", + "description": "Association Type" + }, + "subnet": { + "$ref": "#/definitions/AssociationSubnetUpdate", + "description": "Association Subnet" + } + }, + "description": "The updatable properties of the Association." + }, + "Frontend": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/FrontendProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "Frontend Subresource of Traffic Controller.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "FrontendListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Frontend" + }, + "x-typespec-name": "Frontend[]", + "description": "The Frontend items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + } + }, + "description": "The response of a Frontend list operation.", + "required": [ + "value" + ] + }, + "FrontendProperties": { + "type": "object", + "properties": { + "fqdn": { + "type": "string", + "description": "The Fully Qualified Domain Name of the DNS record associated to a Traffic Controller frontend.", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning State of Traffic Controller Frontend Resource", + "readOnly": true + } + }, + "description": "Frontend Properties." + }, + "FrontendUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-typespec-name": "Record", + "description": "Resource tags." + } + }, + "description": "The type used for update operations of the Frontend." + }, + "ProvisioningState": { + "type": "string", + "enum": [ + "Provisioning", + "Updating", + "Deleting", + "Accepted", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "ResourceId": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of child resource." + } + }, + "description": "Resource ID definition used by parent to reference child resources.", + "required": [ + "id" + ] + }, + "TrafficController": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TrafficControllerProperties", + "description": "The resource-specific properties for this resource.", + "x-ms-client-flatten": true, + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ] + }, + "TrafficControllerListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TrafficController" + }, + "x-typespec-name": "TrafficController[]", + "description": "The TrafficController items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-typespec-name": "TypeSpec.Rest.ResourceLocation" + } + }, + "description": "The response of a TrafficController list operation.", + "required": [ + "value" + ] + }, + "TrafficControllerProperties": { + "type": "object", + "properties": { + "configurationEndpoints": { + "type": "array", + "items": { + "type": "string" + }, + "x-typespec-name": "string[]", + "description": "Configuration Endpoints.", + "readOnly": true + }, + "frontends": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceId" + }, + "x-typespec-name": "ResourceId[]", + "description": "Frontends References List", + "readOnly": true + }, + "associations": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceId" + }, + "x-typespec-name": "ResourceId[]", + "description": "Associations References List", + "readOnly": true + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "The status of the last operation.", + "readOnly": true + } + }, + "description": "Traffic Controller Properties." + }, + "TrafficControllerUpdate": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-typespec-name": "Record", + "description": "Resource tags." + } + }, + "description": "The type used for update operations of the TrafficController." + } + }, + "parameters": {} +} diff --git a/specification/servicenetworking/resource-manager/readme.md b/specification/servicenetworking/resource-manager/readme.md index 5c10b6ea10f9..1ef67b2f3ffe 100644 --- a/specification/servicenetworking/resource-manager/readme.md +++ b/specification/servicenetworking/resource-manager/readme.md @@ -24,9 +24,21 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor These are the global settings for the servicenetworking. + ```yaml openapi-type: arm -tag: package-2022-10-01-preview +tag: package-2023-05-01-preview +``` + +### Tag: package-2023-05-01-preview + +These settings apply only when `--tag=package-2023-05-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-05-01-preview' +input-file: + - Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json +openapi-type: arm +tag: package-2023-05-01-preview ``` ### Tag: package-2022-10-01-preview From 058b50f427b5c09a4c7486e737e337a008c5a471 Mon Sep 17 00:00:00 2001 From: noneumar <113899918+noneumar@users.noreply.github.com> Date: Wed, 3 May 2023 14:07:06 +0300 Subject: [PATCH 07/79] Added includeContext to the example file. (#23771) --- .../2019-03-01/examples/Alerts_List.json | 55 ++++++++++++++++++- 1 file changed, 52 insertions(+), 3 deletions(-) diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/Alerts_List.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/Alerts_List.json index 4021eaf5e8d3..1048bcda0fca 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/Alerts_List.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/examples/Alerts_List.json @@ -1,7 +1,8 @@ { "parameters": { "api-version": "2019-03-01", - "scope": "subscriptions/3b540246-808d-4331-99aa-917b808a9166" + "scope": "subscriptions/3b540246-808d-4331-99aa-917b808a9166", + "includeContext": true }, "responses": { "200": { @@ -34,7 +35,31 @@ "description": "description of the alert" }, "egressConfig": {}, - "context": {} + "context": { + "AlertRuleName": "Test number of results", + "SearchQuery": "traces", + "AlertThresholdOperator": "Greater Than Or Equal To", + "AlertThresholdValue": 0, + "SearchIntervalStartTimeUtc": "2023-04-19T12:02:25Z", + "SearchIntervalEndtimeUtc": "2023-04-19T12:32:25Z", + "ResultCount": 3, + "SearchIntervalInSeconds": 1800, + "LinkToSearchResults": "https://portal.azure.com#@0ef55770-ee07-488d-8dc5-75f53fa5a901/blade/Microsoft_Azure_Monitoring_Logs/LogsBlade/source/Alerts.EmailLinks/scope/%7B%22resources%22%3A%5B%7B%22resourceId%22%3A%22%2Fsubscriptions%2F0ef55770-ee07-488d-8dc5-75f53fa5a901%2FresourceGroups%2Fexample_name%2Fproviders%2Fmicrosoft.insights%2Fcomponents%2FPortal%22%7D%5D%7D/q/eJwreefe4tGAA%3D%3D/prettify/1/timespan/2023-04-19T12%3a02%3a25.0000000Z%2f2023-04-19T12%3a32%3a25.0000000Z", + "LinkToFilteredSearchResultsUI": "https://portal.azure.com#@0ef55770-ee07-488d-8dc5-75f53fa5a901/blade/Microsoft_Azure_Monitoring_Logs/LogsBlade/source/Alerts.EmailLinks/scope/%7B%22resources%22%3A%5B%7B%22resourceId%22%3A%22%2Fsubscriptions%2F0ef55770-ee07-488d-8dc5-75f53fa5a901%2FresourceGroups%2Fexample_resource_group%2Fproviders%2Fmicrosoft.insights%2Fcomponents%2FPortal%22%7D%5D%7D/q/eJwrKUdd0ejhGAA%3D%3D/prettify/1/timespan/2023-04-19T12%3a02%3a25.0000000Z%2f2023-04-19T12%3a32%3a25.0000000Z", + "LinkToSearchResultsAPI": "https://api.applicationinsights.io/v1/apps/e72c8301-003e-4251-aac9-2374b3320ecf/query?query=traces×pan=2023-04-19T12%3a02%3a25.0000000Z%2f2023-04-19T12%3a32%3a25.0000000Z", + "LinkToFilteredSearchResultsAPI": "https://api.applicationinsights.io/v1/apps/e72c8301-003e-4251-aac9-2374b3320ecf/query?query=traces×pan=2023-04-19T12%3a02%3a25.0000000Z%2f2023-04-19T12%3a32%3a25.0000000Z", + "Description": "", + "SeverityDescription": "Informational", + "SubscriptionId": "0ef55770-ee07-488d-8dc5-75f53fa5a901", + "WorkspaceId": "e72c8301-003e-4251-aac9-2374b3320ecf", + "SearchIntervalDurationMin": "30", + "AffectedConfigurationItems": [ + "" + ], + "AlertType": "Number of results", + "IncludeSearchResults": true, + "Frequency": 5 + } }, "id": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/servicedeskresourcegroup/providers/microsoft.insights/components/servicedeskappinsight/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100", "type": "Microsoft.AlertsManagement/alerts", @@ -66,7 +91,31 @@ "description": "description of the alert" }, "egressConfig": {}, - "context": {} + "context": { + "AlertRuleName": "Test number of results", + "SearchQuery": "traces", + "AlertThresholdOperator": "Greater Than Or Equal To", + "AlertThresholdValue": 0, + "SearchIntervalStartTimeUtc": "2023-04-19T12:02:25Z", + "SearchIntervalEndtimeUtc": "2023-04-19T12:32:25Z", + "ResultCount": 3, + "SearchIntervalInSeconds": 1800, + "LinkToSearchResults": "https://portal.azure.com#@0ef55770-ee07-488d-8dc5-75f53fa5a901/blade/Microsoft_Azure_Monitoring_Logs/LogsBlade/source/Alerts.EmailLinks/scope/%7B%22resources%22%3A%5B%7B%22resourceId%22%3A%22%2Fsubscriptions%2F0ef55770-ee07-488d-8dc5-75f53fa5a901%2FresourceGroups%2Fexample_name%2Fproviders%2Fmicrosoft.insights%2Fcomponents%2FPortal%22%7D%5D%7D/q/eJwreefe4tGAA%3D%3D/prettify/1/timespan/2023-04-19T12%3a02%3a25.0000000Z%2f2023-04-19T12%3a32%3a25.0000000Z", + "LinkToFilteredSearchResultsUI": "https://portal.azure.com#@0ef55770-ee07-488d-8dc5-75f53fa5a901/blade/Microsoft_Azure_Monitoring_Logs/LogsBlade/source/Alerts.EmailLinks/scope/%7B%22resources%22%3A%5B%7B%22resourceId%22%3A%22%2Fsubscriptions%2F0ef55770-ee07-488d-8dc5-75f53fa5a901%2FresourceGroups%2Fexample_resource_group%2Fproviders%2Fmicrosoft.insights%2Fcomponents%2FPortal%22%7D%5D%7D/q/eJwrKUdd0ejhGAA%3D%3D/prettify/1/timespan/2023-04-19T12%3a02%3a25.0000000Z%2f2023-04-19T12%3a32%3a25.0000000Z", + "LinkToSearchResultsAPI": "https://api.applicationinsights.io/v1/apps/e72c8301-003e-4251-aac9-2374b3320ecf/query?query=traces×pan=2023-04-19T12%3a02%3a25.0000000Z%2f2023-04-19T12%3a32%3a25.0000000Z", + "LinkToFilteredSearchResultsAPI": "https://api.applicationinsights.io/v1/apps/e72c8301-003e-4251-aac9-2374b3320ecf/query?query=traces×pan=2023-04-19T12%3a02%3a25.0000000Z%2f2023-04-19T12%3a32%3a25.0000000Z", + "Description": "", + "SeverityDescription": "Informational", + "SubscriptionId": "0ef55770-ee07-488d-8dc5-75f53fa5a901", + "WorkspaceId": "e72c8301-003e-4251-aac9-2374b3320ecf", + "SearchIntervalDurationMin": "30", + "AffectedConfigurationItems": [ + "" + ], + "AlertType": "Number of results", + "IncludeSearchResults": true, + "Frequency": 5 + } }, "id": "/subscriptions/3b540246-808d-4331-99aa-917b808a9166/resourcegroups/cind/providers/microsoft.operationalinsights/workspaces/servicedeskwcus/providers/Microsoft.AlertsManagement/alerts/66114d64-d9d9-478b-95c9-b789d6502100", "type": "Microsoft.AlertsManagement/alerts", From 817e7cea0b7e3194868825cbef6d4e62a7895951 Mon Sep 17 00:00:00 2001 From: Dipesh Bhakat <107024030+dipeshbhakat-microsoft@users.noreply.github.com> Date: Thu, 4 May 2023 05:49:55 +0530 Subject: [PATCH 08/79] Update Monitors_CreateOrUpdate_MaximumSet_Gen.json (#23787) Remove managed identity from the example payload as those will be created by system automatically. --- ...onitors_CreateOrUpdate_MaximumSet_Gen.json | 28 ------------------- 1 file changed, 28 deletions(-) diff --git a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json index d06419fbb8b1..9a497037a7d9 100644 --- a/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json +++ b/specification/newrelic/resource-manager/NewRelic.Observability/stable/2022-07-01/examples/Monitors_CreateOrUpdate_MaximumSet_Gen.json @@ -45,12 +45,6 @@ "orgCreationSource": "LIFTR", "accountCreationSource": "LIFTR" }, - "identity": { - "type": "None", - "userAssignedIdentities": { - "key8903": {} - } - }, "tags": { "key6976": "oaxfhf" }, @@ -99,17 +93,6 @@ "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" }, @@ -171,17 +154,6 @@ "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" }, From 0c594612af3431c3602d71523aa6ca5b1ebd49ce Mon Sep 17 00:00:00 2001 From: zeusone <1017794634@qq.com> Date: Thu, 4 May 2023 10:45:42 +0800 Subject: [PATCH 09/79] [Hub Generated] Review request for Microsoft.HDInsight to add version preview/2023-04-15-preview (#23743) * Adds base for updating Microsoft.HDInsight from version stable/2021-06-01 to version 2023-04-15-preview * Updates readme * Updates API version in new specs and examples * modify request and examples * fix ErrorResponse * Revert "fix ErrorResponse" This reverts commit 65b7c6caac1c8c8e134aa1b6c56d54876b634b4d. --------- Co-authored-by: Zhenhai Cao --- .../2023-04-15-preview/applications.json | 543 ++++ .../preview/2023-04-15-preview/cluster.json | 2256 +++++++++++++++++ .../2023-04-15-preview/configurations.json | 250 ++ .../ApprovePrivateEndpointConnection.json | 58 + .../ChangeHttpConnectivityDisable.json | 21 + .../ChangeHttpConnectivityEnable.json | 23 + .../examples/CreateApplication.json | 94 + .../examples/CreateExtension.json | 17 + ...teHDInsightClusterWithAutoscaleConfig.json | 203 ++ ...HDInsightClusterWithAvailabilityZones.json | 195 ++ ...ClusterWithComputeIsolationProperties.json | 150 ++ ...ghtClusterWithCustomNetworkProperties.json | 162 ++ ...eHDInsightClusterWithEncryptionAtHost.json | 177 ++ ...InsightClusterWithEncryptionInTransit.json | 172 ++ .../CreateHDInsightClusterWithTLS12.json | 168 ++ .../CreateKafkaClusterWithKafkaRestProxy.json | 224 ++ .../examples/CreateLinuxHadoopAdlsGen2.json | 171 ++ .../CreateLinuxHadoopSecureHadoop.json | 220 ++ .../CreateLinuxHadoopSshPassword.json | 171 ++ .../CreateLinuxHadoopSshPublicKey.json | 177 ++ .../examples/CreateLinuxSparkSshPassword.json | 160 ++ .../examples/DeleteApplication.json | 22 + .../examples/DeleteExtension.json | 18 + .../examples/DeleteLinuxHadoopCluster.json | 17 + .../DeletePrivateEndpointConnection.json | 18 + .../examples/DeleteScriptAction.json | 13 + .../examples/DisableClusterAutoScale.json | 18 + .../DisableLinuxClusterAzureMonitor.json | 17 + .../DisableLinuxClusterMonitoring.json | 17 + .../EnableLinuxClusterAzureMonitor.json | 16 + .../EnableLinuxClusterMonitoring.json | 16 + ...teAutoScaleWithLoadBasedConfiguration.json | 25 + ...toScaleWithScheduleBasedConfiguration.json | 36 + .../examples/GetAllApplications.json | 118 + ...llPrivateEndpointConnectionsInCluster.json | 33 + .../GetAllPrivateLinkResourcesInCluster.json | 44 + .../examples/GetApplicationCreated.json | 67 + ...plicationCreationAsyncOperationStatus.json | 17 + .../examples/GetApplicationInProgress.json | 61 + ...etClusterCreatingAsyncOperationStatus.json | 16 + .../examples/GetClusterVirtualMachines.json | 41 + .../examples/GetExtension.json | 17 + ...ExtensionCreationAsyncOperationStatus.json | 17 + .../examples/GetHDInsightCapabilities.json | 384 +++ .../examples/GetHDInsightUsages.json | 24 + .../GetLinuxClusterAzureMonitorStatus.json | 16 + .../GetLinuxClusterMonitoringStatus.json | 16 + .../examples/GetLinuxHadoopAllClusters.json | 172 ++ ...LinuxHadoopAllClustersInResourceGroup.json | 173 ++ .../examples/GetLinuxHadoopCluster.json | 91 + .../examples/GetLinuxHadoopScriptAction.json | 24 + .../examples/GetLinuxSparkCluster.json | 94 + .../GetPrivateEndpointConnection.json | 30 + .../examples/GetPrivateLinkResource.json | 27 + .../GetRestartHostsAsyncOperationStatus.json | 16 + .../examples/GetScriptActionById.json | 29 + ...etScriptExecutionAsyncOperationStatus.json | 16 + .../examples/GetScriptExecutionHistory.json | 47 + .../HDI_Clusters_GetGatewaySettings.json | 17 + ...ters_UpdateClusterIdentityCertificate.json | 21 + ...Clusters_UpdateGatewaySettings_Enable.json | 25 + .../examples/HDI_Configurations_Get.json | 17 + .../examples/HDI_Configurations_List.json | 25 + ...ocations_CheckClusterNameAvailability.json | 20 + ...HDI_Locations_GetAsyncOperationStatus.json | 15 + .../HDI_Locations_ListBillingSpecs.json | 63 + ...ocations_ValidateClusterCreateRequest.json | 111 + .../examples/ListHDInsightOperations.json | 33 + .../examples/PatchLinuxHadoopCluster.json | 98 + .../examples/PostExecuteScriptAction.json | 31 + .../PromoteLinuxHadoopScriptAction.json | 12 + .../examples/ResizeLinuxHadoopCluster.json | 20 + .../RestartVirtualMachinesOperation.json | 24 + ...teLinuxHadoopClusterDiskEncryptionKey.json | 21 + .../2023-04-15-preview/extensions.json | 686 +++++ .../preview/2023-04-15-preview/locations.json | 938 +++++++ .../2023-04-15-preview/operations.json | 295 +++ .../privateEndpointConnections.json | 404 +++ .../privateLinkResources.json | 200 ++ .../2023-04-15-preview/scriptActions.json | 513 ++++ .../2023-04-15-preview/virtualMachines.json | 273 ++ .../hdinsight/resource-manager/readme.md | 44 +- 82 files changed, 11323 insertions(+), 18 deletions(-) create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/applications.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/configurations.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ApprovePrivateEndpointConnection.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ChangeHttpConnectivityDisable.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ChangeHttpConnectivityEnable.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateApplication.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateExtension.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAutoscaleConfig.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAvailabilityZones.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithComputeIsolationProperties.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithCustomNetworkProperties.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionAtHost.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithTLS12.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateKafkaClusterWithKafkaRestProxy.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopAdlsGen2.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSecureHadoop.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSshPassword.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSshPublicKey.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxSparkSshPassword.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteApplication.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteExtension.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteLinuxHadoopCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeletePrivateEndpointConnection.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteScriptAction.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableClusterAutoScale.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableLinuxClusterAzureMonitor.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableLinuxClusterMonitoring.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableLinuxClusterAzureMonitor.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableLinuxClusterMonitoring.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableOrUpdateAutoScaleWithLoadBasedConfiguration.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableOrUpdateAutoScaleWithScheduleBasedConfiguration.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllApplications.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllPrivateEndpointConnectionsInCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllPrivateLinkResourcesInCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationCreated.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationCreationAsyncOperationStatus.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationInProgress.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetClusterCreatingAsyncOperationStatus.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetClusterVirtualMachines.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetExtension.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetExtensionCreationAsyncOperationStatus.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetHDInsightCapabilities.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetHDInsightUsages.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxClusterAzureMonitorStatus.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxClusterMonitoringStatus.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopAllClusters.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopScriptAction.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxSparkCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetPrivateEndpointConnection.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetPrivateLinkResource.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetRestartHostsAsyncOperationStatus.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptActionById.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptExecutionAsyncOperationStatus.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptExecutionHistory.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_GetGatewaySettings.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_UpdateClusterIdentityCertificate.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_UpdateGatewaySettings_Enable.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Configurations_Get.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Configurations_List.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_CheckClusterNameAvailability.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_GetAsyncOperationStatus.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_ListBillingSpecs.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_ValidateClusterCreateRequest.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ListHDInsightOperations.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PatchLinuxHadoopCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PostExecuteScriptAction.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PromoteLinuxHadoopScriptAction.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ResizeLinuxHadoopCluster.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/RestartVirtualMachinesOperation.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/extensions.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/locations.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/operations.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/privateEndpointConnections.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/privateLinkResources.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/scriptActions.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/virtualMachines.json diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/applications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/applications.json new file mode 100644 index 000000000000..c551d8cb8cb9 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/applications.json @@ -0,0 +1,543 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2023-04-15-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/clusters/{clusterName}/applications": { + "get": { + "tags": [ + "Applications" + ], + "description": "Lists all of the applications for the HDInsight cluster.", + "operationId": "Applications_ListByCluster", + "x-ms-examples": { + "Get All Applications for an HDInsight cluster": { + "$ref": "./examples/GetAllApplications.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ApplicationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}": { + "get": { + "tags": [ + "Applications" + ], + "description": "Gets properties of the specified application.", + "operationId": "Applications_Get", + "x-ms-examples": { + "Get application on HDInsight cluster successfully created.": { + "$ref": "./examples/GetApplicationCreated.json" + }, + "Get application on HDInsight cluster creation in progress": { + "$ref": "./examples/GetApplicationInProgress.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Application" + } + } + } + }, + "put": { + "tags": [ + "Applications" + ], + "description": "Creates applications for the HDInsight cluster.", + "operationId": "Applications_Create", + "x-ms-examples": { + "Create Application": { + "$ref": "./examples/CreateApplication.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Application" + }, + "description": "The application create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Application" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "delete": { + "tags": [ + "Applications" + ], + "description": "Deletes the specified application on the HDInsight cluster.", + "operationId": "Applications_Delete", + "x-ms-examples": { + "Delete Application from HDInsight cluster": { + "$ref": "./examples/DeleteApplication.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted response definition." + }, + "204": { + "description": "No Content response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/applications/{applicationName}/azureasyncoperations/{operationId}": { + "get": { + "tags": [ + "Applications" + ], + "description": "Gets the async operation status.", + "operationId": "Applications_GetAzureAsyncOperationStatus", + "x-ms-examples": { + "Get the azure async operation status.": { + "$ref": "./examples/GetApplicationCreationAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApplicationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "./cluster.json#/definitions/AsyncOperationResult" + } + } + } + } + } + }, + "definitions": { + "ApplicationGetHttpsEndpoint": { + "description": "Gets the application HTTP endpoints.", + "type": "object", + "properties": { + "accessModes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of access modes for the application." + }, + "location": { + "type": "string", + "description": "The location of the endpoint.", + "readOnly": true + }, + "destinationPort": { + "type": "integer", + "format": "int32", + "description": "The destination port to connect to." + }, + "publicPort": { + "type": "integer", + "format": "int32", + "description": "The public port to connect to.", + "readOnly": true + }, + "privateIPAddress": { + "type": "string", + "description": "The private ip address of the endpoint.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "subDomainSuffix": { + "type": "string", + "description": "The subdomain suffix of the application.", + "x-ms-mutability": [ + "create", + "update" + ] + }, + "disableGatewayAuth": { + "type": "boolean", + "description": "The value indicates whether to disable GatewayAuth." + } + } + }, + "ApplicationGetEndpoint": { + "description": "Gets the application SSH endpoint", + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location of the endpoint." + }, + "destinationPort": { + "type": "integer", + "format": "int32", + "description": "The destination port to connect to." + }, + "publicPort": { + "type": "integer", + "format": "int32", + "description": "The public port to connect to." + }, + "privateIPAddress": { + "type": "string", + "description": "The private ip address of the endpoint.", + "x-ms-mutability": [ + "create", + "read" + ] + } + } + }, + "ApplicationProperties": { + "description": "The HDInsight cluster application GET response.", + "type": "object", + "properties": { + "computeProfile": { + "$ref": "./cluster.json#/definitions/ComputeProfile", + "description": "The list of roles in the cluster." + }, + "installScriptActions": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptAction" + }, + "x-ms-identifiers": [], + "description": "The list of install script actions." + }, + "uninstallScriptActions": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptAction" + }, + "x-ms-identifiers": [], + "description": "The list of uninstall script actions." + }, + "httpsEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGetHttpsEndpoint" + }, + "x-ms-identifiers": [], + "description": "The list of application HTTPS endpoints." + }, + "sshEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGetEndpoint" + }, + "x-ms-identifiers": [], + "description": "The list of application SSH endpoints." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the application." + }, + "applicationType": { + "type": "string", + "description": "The application type." + }, + "applicationState": { + "readOnly": true, + "type": "string", + "description": "The application state." + }, + "errors": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/Errors" + }, + "x-ms-identifiers": [ + "code" + ], + "description": "The list of errors." + }, + "createdDate": { + "readOnly": true, + "type": "string", + "description": "The application create date time." + }, + "marketplaceIdentifier": { + "readOnly": true, + "type": "string", + "description": "The marketplace identifier." + }, + "privateLinkConfigurations": { + "type": "array", + "description": "The private link configurations.", + "items": { + "$ref": "./cluster.json#/definitions/PrivateLinkConfiguration" + } + } + } + }, + "Application": { + "description": "The HDInsight cluster application", + "type": "object", + "allOf": [ + { + "$ref": "./cluster.json#/definitions/ProxyResource" + } + ], + "properties": { + "etag": { + "description": "The ETag for the application", + "type": "string" + }, + "tags": { + "description": "The tags for the application.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/ApplicationProperties", + "description": "The properties of the application." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + } + }, + "ApplicationListResult": { + "type": "object", + "description": "Result of the request to list cluster Applications. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Application" + }, + "description": "The list of HDInsight applications installed on HDInsight cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of operation list results if there are any." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApplicationNameParameter": { + "name": "applicationName", + "in": "path", + "required": true, + "type": "string", + "description": "The constant value for the application name.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The long running operation id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json new file mode 100644 index 000000000000..5c9df73cbdaa --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json @@ -0,0 +1,2256 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2023-04-15-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/clusters/{clusterName}": { + "put": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Create", + "description": "Creates a new HDInsight cluster with the specified parameters.", + "x-ms-examples": { + "Create Hadoop on Linux cluster with SSH password": { + "$ref": "./examples/CreateLinuxHadoopSshPassword.json" + }, + "Create Hadoop on Linux cluster with SSH public key": { + "$ref": "./examples/CreateLinuxHadoopSshPublicKey.json" + }, + "Create Spark on Linux Cluster with SSH password": { + "$ref": "./examples/CreateLinuxSparkSshPassword.json" + }, + "Create Secure Hadoop cluster": { + "$ref": "./examples/CreateLinuxHadoopSecureHadoop.json" + }, + "Create Hadoop cluster with Azure Data Lake Storage Gen 2": { + "$ref": "./examples/CreateLinuxHadoopAdlsGen2.json" + }, + "Create HDInsight cluster with Autoscale configuration": { + "$ref": "./examples/CreateHDInsightClusterWithAutoscaleConfig.json" + }, + "Create Kafka cluster with Kafka Rest Proxy": { + "$ref": "./examples/CreateKafkaClusterWithKafkaRestProxy.json" + }, + "Create cluster with TLS 1.2": { + "$ref": "./examples/CreateHDInsightClusterWithTLS12.json" + }, + "Create cluster with encryption in transit": { + "$ref": "./examples/CreateHDInsightClusterWithEncryptionInTransit.json" + }, + "Create cluster with encryption at host": { + "$ref": "./examples/CreateHDInsightClusterWithEncryptionAtHost.json" + }, + "Create cluster with network properties": { + "$ref": "./examples/CreateHDInsightClusterWithCustomNetworkProperties.json" + }, + "Create cluster with compute isolation properties": { + "$ref": "./examples/CreateHDInsightClusterWithComputeIsolationProperties.json" + }, + "Create cluster with availability zones": { + "$ref": "./examples/CreateHDInsightClusterWithAvailabilityZones.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterCreateParametersExtended" + }, + "description": "The cluster create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Update", + "description": "Patch HDInsight cluster with the specified parameters.", + "x-ms-examples": { + "Patch HDInsight Linux clusters": { + "$ref": "./examples/PatchLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPatchParameters" + }, + "description": "The cluster patch request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Delete", + "description": "Deletes the specified HDInsight cluster.", + "x-ms-examples": { + "Delete Hadoop on Linux cluster": { + "$ref": "./examples/DeleteLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted response definition." + }, + "200": { + "description": "Ok response definition." + }, + "204": { + "description": "No Content response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Get", + "description": "Gets the specified cluster.", + "x-ms-examples": { + "Get Hadoop on Linux cluster": { + "$ref": "./examples/GetLinuxHadoopCluster.json" + }, + "Get Spark on Linux cluster": { + "$ref": "./examples/GetLinuxSparkCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/Cluster" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "description": "Lists the HDInsight clusters in a resource group.", + "x-ms-examples": { + "Get All Hadoop on Linux clusters in a resource group": { + "$ref": "./examples/GetLinuxHadoopAllClustersInResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/resize": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Resize", + "description": "Resizes the specified HDInsight cluster to the specified size.", + "x-ms-examples": { + "Resize the worker nodes for a Hadoop on Linux cluster": { + "$ref": "./examples/ResizeLinuxHadoopCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The constant value for the roleName", + "enum": [ + "workernode" + ], + "x-ms-enum": { + "name": "RoleName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterResizeParameters" + }, + "description": "The parameters for the resize operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/roles/{roleName}/autoscale": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_UpdateAutoScaleConfiguration", + "description": "Updates the Autoscale Configuration for HDInsight cluster.", + "x-ms-examples": { + "Enable or Update Autoscale with the load based configuration for HDInsight cluster": { + "$ref": "./examples/EnableOrUpdateAutoScaleWithLoadBasedConfiguration.json" + }, + "Enable or Update Autoscale with the schedule based configuration for HDInsight cluster": { + "$ref": "./examples/EnableOrUpdateAutoScaleWithScheduleBasedConfiguration.json" + }, + "Disable Autoscale for the HDInsight cluster": { + "$ref": "./examples/DisableClusterAutoScale.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The constant value for the roleName", + "enum": [ + "workernode" + ], + "x-ms-enum": { + "name": "RoleName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutoscaleConfigurationUpdateParameter" + }, + "description": "The parameters for the update autoscale configuration operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_List", + "x-ms-examples": { + "Get All Hadoop on Linux clusters": { + "$ref": "./examples/GetLinuxHadoopAllClusters.json" + } + }, + "description": "Lists all the HDInsight clusters under the subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/rotatediskencryptionkey": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_RotateDiskEncryptionKey", + "x-ms-examples": { + "Rotate disk encryption key of the specified HDInsight cluster": { + "$ref": "./examples/RotateLinuxHadoopClusterDiskEncryptionKey.json" + } + }, + "description": "Rotate disk encryption key of the specified HDInsight cluster.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterDiskEncryptionParameters" + }, + "description": "The parameters for the disk encryption operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/getGatewaySettings": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_GetGatewaySettings", + "description": "Gets the gateway settings for the specified cluster.", + "x-ms-examples": { + "Get HTTP settings": { + "$ref": "./examples/HDI_Clusters_GetGatewaySettings.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/GatewaySettings" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/updateGatewaySettings": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_UpdateGatewaySettings", + "description": "Configures the gateway settings on the specified cluster.", + "x-ms-examples": { + "Enable HTTP connectivity": { + "$ref": "./examples/HDI_Clusters_UpdateGatewaySettings_Enable.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateGatewaySettingsParameters" + }, + "description": "The cluster configurations." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/azureasyncoperations/{operationId}": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_GetAzureAsyncOperationStatus", + "description": "The the async operation status.", + "x-ms-examples": { + "Get Async Operation Status of Creating Cluster": { + "$ref": "./examples/GetClusterCreatingAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/AsyncOperationResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/updateClusterIdentityCertificate": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_UpdateIdentityCertificate", + "description": "Updates the cluster identity certificate.", + "x-ms-examples": { + "Update cluster identity certificate": { + "$ref": "./examples/HDI_Clusters_UpdateClusterIdentityCertificate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateClusterIdentityCertificateParameters" + }, + "description": "The cluster configurations." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ClusterDefinition": { + "type": "object", + "description": "The cluster definition.", + "properties": { + "blueprint": { + "type": "string", + "description": "The link to the blueprint." + }, + "kind": { + "type": "string", + "description": "The type of cluster." + }, + "componentVersion": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The versions of different services in the cluster.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "configurations": { + "type": "object", + "description": "The cluster configurations.", + "x-ms-secret": true + } + } + }, + "ClientGroupInfo": { + "type": "object", + "description": "The information of AAD security group.", + "properties": { + "groupName": { + "type": "string", + "description": "The AAD security group name." + }, + "groupId": { + "type": "string", + "description": "The AAD security group id." + } + } + }, + "KafkaRestProperties": { + "type": "object", + "description": "The kafka rest proxy configuration which contains AAD security group information.", + "properties": { + "clientGroupInfo": { + "$ref": "#/definitions/ClientGroupInfo", + "description": "The information of AAD security group." + }, + "configurationOverride": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The configurations that need to be overriden." + } + } + }, + "SecurityProfile": { + "type": "object", + "description": "The security profile which contains Ssh public key for the HDInsight cluster.", + "properties": { + "directoryType": { + "type": "string", + "description": "The directory type.", + "enum": [ + "ActiveDirectory" + ], + "x-ms-enum": { + "name": "DirectoryType", + "modelAsString": true + } + }, + "domain": { + "type": "string", + "description": "The organization's active directory domain." + }, + "organizationalUnitDN": { + "type": "string", + "description": "The organizational unit within the Active Directory to place the cluster and service accounts.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "ldapsUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The LDAPS protocol URLs to communicate with the Active Directory." + }, + "domainUsername": { + "type": "string", + "description": "The domain user account that will have admin privileges on the cluster." + }, + "domainUserPassword": { + "type": "string", + "format": "password", + "description": "The domain admin password." + }, + "clusterUsersGroupDNs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. The Distinguished Names for cluster user groups" + }, + "aaddsResourceId": { + "type": "string", + "description": "The resource ID of the user's Azure Active Directory Domain Service." + }, + "msiResourceId": { + "type": "string", + "description": "User assigned identity that has permissions to read and create cluster-related artifacts in the user's AADDS." + } + } + }, + "AutoscaleTimeAndCapacity": { + "type": "object", + "properties": { + "time": { + "type": "string", + "description": "24-hour time in the form xx:xx" + }, + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The minimum instance count of the cluster" + }, + "maxInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The maximum instance count of the cluster" + } + }, + "description": "Time and capacity request parameters" + }, + "AutoscaleSchedule": { + "type": "object", + "properties": { + "days": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DaysOfWeek", + "modelAsString": true + } + }, + "description": "Days of the week for a schedule-based autoscale rule" + }, + "timeAndCapacity": { + "$ref": "#/definitions/AutoscaleTimeAndCapacity", + "description": "Time and capacity for a schedule-based autoscale rule" + } + }, + "description": "Parameters for a schedule-based autoscale rule, consisting of an array of days + a time and capacity" + }, + "AutoscaleCapacity": { + "type": "object", + "properties": { + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The minimum instance count of the cluster" + }, + "maxInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The maximum instance count of the cluster" + } + }, + "description": "The load-based autoscale request parameters" + }, + "AutoscaleRecurrence": { + "type": "object", + "properties": { + "timeZone": { + "type": "string", + "description": "The time zone for the autoscale schedule times" + }, + "schedule": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoscaleSchedule" + }, + "x-ms-identifiers": [], + "description": "Array of schedule-based autoscale rules" + } + }, + "description": "Schedule-based autoscale request parameters" + }, + "Autoscale": { + "type": "object", + "properties": { + "capacity": { + "$ref": "#/definitions/AutoscaleCapacity", + "description": "Parameters for load-based autoscale" + }, + "recurrence": { + "$ref": "#/definitions/AutoscaleRecurrence", + "description": "Parameters for schedule-based autoscale" + } + }, + "description": "The autoscale request parameters" + }, + "AutoscaleConfigurationUpdateParameter": { + "type": "object", + "properties": { + "autoscale": { + "$ref": "#/definitions/Autoscale", + "description": "The autoscale configuration." + } + }, + "description": "The autoscale configuration update parameter." + }, + "HardwareProfile": { + "type": "object", + "properties": { + "vmSize": { + "type": "string", + "description": "The size of the VM" + } + }, + "description": "The hardware profile." + }, + "VirtualNetworkProfile": { + "type": "object", + "description": "The virtual network properties.", + "properties": { + "id": { + "type": "string", + "description": "The ID of the virtual network." + }, + "subnet": { + "type": "string", + "description": "The name of the subnet." + } + } + }, + "DataDisksGroups": { + "type": "object", + "description": "The data disks groups for the role.", + "properties": { + "disksPerNode": { + "type": "integer", + "format": "int32", + "description": "The number of disks per node." + }, + "storageAccountType": { + "type": "string", + "description": "ReadOnly. The storage account type. Do not set this value.", + "readOnly": true + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "ReadOnly. The DiskSize in GB. Do not set this value.", + "readOnly": true + } + } + }, + "SshPublicKey": { + "type": "object", + "description": "The SSH public key for the cluster nodes.", + "properties": { + "certificateData": { + "type": "string", + "description": "The certificate for SSH." + } + } + }, + "SshProfile": { + "type": "object", + "description": "The list of SSH public keys.", + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "x-ms-identifiers": [ + "certificateData" + ], + "description": "The list of SSH public keys." + } + } + }, + "LinuxOperatingSystemProfile": { + "type": "object", + "description": "The ssh username, password, and ssh public key.", + "properties": { + "username": { + "type": "string", + "description": "The username." + }, + "password": { + "type": "string", + "description": "The password." + }, + "sshProfile": { + "$ref": "#/definitions/SshProfile", + "description": "The SSH profile.", + "x-ms-secret": true + } + } + }, + "OsProfile": { + "type": "object", + "description": "The Linux operation systems profile.", + "properties": { + "linuxOperatingSystemProfile": { + "$ref": "#/definitions/LinuxOperatingSystemProfile", + "description": "The Linux OS profile." + } + } + }, + "Role": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the role." + }, + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The minimum instance count of the cluster.", + "x-ms-secret": true + }, + "targetInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The instance count of the cluster." + }, + "VMGroupName": { + "type": "string", + "description": "The name of the virtual machine group.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "autoscale": { + "$ref": "#/definitions/Autoscale", + "x-ms-client-name": "autoscaleConfiguration", + "description": "The autoscale configurations." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "The hardware profile." + }, + "osProfile": { + "$ref": "#/definitions/OsProfile", + "description": "The operating system profile." + }, + "virtualNetworkProfile": { + "$ref": "#/definitions/VirtualNetworkProfile", + "description": "The virtual network profile." + }, + "dataDisksGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisksGroups" + }, + "x-ms-identifiers": [], + "description": "The data disks groups for the role." + }, + "scriptActions": { + "type": "array", + "items": { + "$ref": "./scriptActions.json#/definitions/ScriptAction" + }, + "x-ms-identifiers": [], + "description": "The list of script actions on the role.", + "x-ms-secret": true + }, + "encryptDataDisks": { + "type": "boolean", + "description": "Indicates whether encrypt the data disks.", + "default": false + } + }, + "description": "Describes a role on the cluster." + }, + "ComputeProfile": { + "type": "object", + "properties": { + "roles": { + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of roles in the cluster." + } + }, + "description": "Describes the compute profile." + }, + "StorageAccount": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the storage account." + }, + "isDefault": { + "type": "boolean", + "description": "Whether or not the storage account is the default storage account." + }, + "container": { + "type": "string", + "description": "The container in the storage account, only to be specified for WASB storage accounts." + }, + "fileSystem": { + "type": "string", + "description": "The filesystem, only to be specified for Azure Data Lake Storage Gen 2." + }, + "key": { + "type": "string", + "description": "The storage account access key." + }, + "resourceId": { + "type": "string", + "description": "The resource ID of storage account, only to be specified for Azure Data Lake Storage Gen 2." + }, + "msiResourceId": { + "type": "string", + "description": "The managed identity (MSI) that is allowed to access the storage account, only to be specified for Azure Data Lake Storage Gen 2." + }, + "saskey": { + "type": "string", + "description": "The shared access signature key." + }, + "fileshare": { + "type": "string", + "description": "The file share name." + }, + "enableSecureChannel": { + "type": "boolean", + "description": "Enable secure channel or not, it's an optional field. Default value is false when cluster version < 5.1 and true when cluster version >= 5.1 , " + } + }, + "description": "The storage Account." + }, + "StorageProfile": { + "type": "object", + "properties": { + "storageaccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of storage accounts in the cluster." + } + }, + "description": "The storage profile." + }, + "ExcludedServicesConfig": { + "type": "object", + "properties": { + "excludedServicesConfigId": { + "type": "string", + "description": "The config id of excluded services." + }, + "excludedServicesList": { + "type": "string", + "description": "The list of excluded services." + } + }, + "description": "The configuration that services will be excluded when creating cluster." + }, + "NetworkProperties": { + "type": "object", + "description": "The network properties.", + "properties": { + "resourceProviderConnection": { + "type": "string", + "description": "The direction for the resource provider connection.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "ResourceProviderConnection", + "modelAsString": true + } + }, + "privateLink": { + "type": "string", + "description": "Indicates whether or not private link is enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "PrivateLink", + "modelAsString": true + } + } + } + }, + "ComputeIsolationProperties": { + "type": "object", + "description": "The compute isolation properties.", + "properties": { + "enableComputeIsolation": { + "type": "boolean", + "description": "The flag indicates whether enable compute isolation or not.", + "default": false + }, + "hostSku": { + "type": "string", + "description": "The host sku." + } + } + }, + "ClusterCreateProperties": { + "type": "object", + "description": "The cluster create parameters.", + "properties": { + "clusterVersion": { + "type": "string", + "description": "The version of the cluster." + }, + "osType": { + "type": "string", + "description": "The type of operating system.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "The cluster tier.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "Tier", + "modelAsString": true + }, + "default": "Standard", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "clusterDefinition": { + "$ref": "#/definitions/ClusterDefinition", + "description": "The cluster definition." + }, + "kafkaRestProperties": { + "$ref": "#/definitions/KafkaRestProperties", + "description": "The cluster kafka rest proxy configuration." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "The security profile." + }, + "computeProfile": { + "$ref": "#/definitions/ComputeProfile", + "description": "The compute profile." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "The storage profile." + }, + "diskEncryptionProperties": { + "$ref": "#/definitions/DiskEncryptionProperties", + "description": "The disk encryption properties." + }, + "encryptionInTransitProperties": { + "$ref": "#/definitions/EncryptionInTransitProperties", + "description": "The encryption-in-transit properties." + }, + "minSupportedTlsVersion": { + "type": "string", + "description": "The minimal supported tls version." + }, + "networkProperties": { + "$ref": "#/definitions/NetworkProperties", + "description": "The network properties." + }, + "computeIsolationProperties": { + "$ref": "#/definitions/ComputeIsolationProperties", + "description": "The compute isolation properties." + }, + "privateLinkConfigurations": { + "type": "array", + "description": "The private link configurations.", + "items": { + "$ref": "#/definitions/PrivateLinkConfiguration" + } + } + } + }, + "ClusterCreateParametersExtended": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The location of the cluster." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The availability zones." + }, + "properties": { + "$ref": "#/definitions/ClusterCreateProperties", + "description": "The cluster create parameters." + }, + "identity": { + "$ref": "#/definitions/ClusterIdentity", + "description": "The identity of the cluster, if configured." + } + }, + "description": "The CreateCluster request parameters." + }, + "ClusterPatchParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "x-nullable": true, + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "description": "The PatchCluster request parameters" + }, + "QuotaInfo": { + "type": "object", + "description": "The quota properties for the cluster.", + "properties": { + "coresUsed": { + "type": "integer", + "format": "int32", + "description": "The cores used by the cluster." + } + } + }, + "Errors": { + "type": "object", + "description": "The error message associated with the cluster creation.", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + } + }, + "ConnectivityEndpoint": { + "type": "object", + "description": "The connectivity properties", + "properties": { + "name": { + "type": "string", + "description": "The name of the endpoint." + }, + "protocol": { + "type": "string", + "description": "The protocol of the endpoint." + }, + "location": { + "type": "string", + "description": "The location of the endpoint." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port to connect to." + }, + "privateIPAddress": { + "type": "string", + "description": "The private ip address of the endpoint." + } + } + }, + "ClusterGetProperties": { + "type": "object", + "description": "The properties of cluster.", + "properties": { + "clusterVersion": { + "type": "string", + "description": "The version of the cluster." + }, + "clusterHdpVersion": { + "type": "string", + "description": "The hdp version of the cluster." + }, + "osType": { + "type": "string", + "description": "The type of operating system.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "The cluster tier.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "Tier", + "modelAsString": true + } + }, + "clusterId": { + "type": "string", + "description": "The cluster id." + }, + "clusterDefinition": { + "$ref": "#/definitions/ClusterDefinition", + "description": "The cluster definition." + }, + "kafkaRestProperties": { + "$ref": "#/definitions/KafkaRestProperties", + "description": "The cluster kafka rest proxy configuration." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "The security profile." + }, + "computeProfile": { + "$ref": "#/definitions/ComputeProfile", + "description": "The compute profile." + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "Canceled", + "Deleting" + ], + "x-ms-enum": { + "name": "HDInsightClusterProvisioningState", + "modelAsString": true + } + }, + "createdDate": { + "type": "string", + "description": "The date on which the cluster was created." + }, + "clusterState": { + "type": "string", + "description": "The state of the cluster." + }, + "quotaInfo": { + "$ref": "#/definitions/QuotaInfo", + "description": "The quota information." + }, + "errors": { + "type": "array", + "items": { + "$ref": "#/definitions/Errors" + }, + "x-ms-identifiers": [ + "code" + ], + "description": "The list of errors." + }, + "connectivityEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectivityEndpoint" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of connectivity endpoints." + }, + "diskEncryptionProperties": { + "$ref": "#/definitions/DiskEncryptionProperties", + "description": "The disk encryption properties." + }, + "encryptionInTransitProperties": { + "$ref": "#/definitions/EncryptionInTransitProperties", + "description": "The encryption-in-transit properties." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "The storage profile." + }, + "minSupportedTlsVersion": { + "type": "string", + "description": "The minimal supported tls version." + }, + "excludedServicesConfig": { + "$ref": "#/definitions/ExcludedServicesConfig", + "description": "The excluded services config." + }, + "networkProperties": { + "$ref": "#/definitions/NetworkProperties", + "description": "The network properties." + }, + "computeIsolationProperties": { + "$ref": "#/definitions/ComputeIsolationProperties", + "description": "The compute isolation properties." + }, + "privateLinkConfigurations": { + "type": "array", + "description": "The private link configurations.", + "items": { + "$ref": "#/definitions/PrivateLinkConfiguration" + } + }, + "privateEndpointConnections": { + "type": "array", + "description": "The list of private endpoint connections.", + "items": { + "$ref": "./privateEndpointConnections.json#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + } + }, + "required": [ + "clusterDefinition" + ] + }, + "Cluster": { + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "etag": { + "type": "string", + "description": "The ETag for the resource" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The availability zones." + }, + "properties": { + "$ref": "#/definitions/ClusterGetProperties", + "description": "The properties of the cluster." + }, + "identity": { + "$ref": "#/definitions/ClusterIdentity", + "description": "The identity of the cluster, if configured." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "description": "The HDInsight cluster." + }, + "RuntimeScriptAction": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script" + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of roles where script will be executed." + }, + "applicationName": { + "readOnly": true, + "type": "string", + "description": "The application name of the script action, if any." + } + }, + "required": [ + "name", + "uri", + "roles" + ], + "description": "Describes a script action on a running cluster." + }, + "ExecuteScriptActionParameters": { + "type": "object", + "properties": { + "scriptActions": { + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptAction" + }, + "x-ms-identifiers": [], + "description": "The list of run time script actions." + }, + "persistOnSuccess": { + "type": "boolean", + "description": "Gets or sets if the scripts needs to be persisted." + } + }, + "required": [ + "persistOnSuccess" + ], + "description": "The parameters for the script actions to execute on a running cluster." + }, + "ClusterListPersistedScriptActionsResult": { + "type": "object", + "properties": { + "value": { + "description": "The list of Persisted Script Actions.", + "type": "array", + "items": { + "$ref": "#/definitions/RuntimeScriptAction" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The ListPersistedScriptActions operation response." + }, + "ScriptActionExecutionSummary": { + "type": "object", + "properties": { + "status": { + "readOnly": true, + "type": "string", + "description": "The status of script action execution." + }, + "instanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The instance count for a given script action execution status." + } + }, + "description": "The execution summary of a script action." + }, + "RuntimeScriptActionDetail": { + "allOf": [ + { + "$ref": "#/definitions/RuntimeScriptAction" + } + ], + "type": "object", + "properties": { + "scriptExecutionId": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The execution id of the script action." + }, + "startTime": { + "readOnly": true, + "type": "string", + "description": "The start time of script action execution." + }, + "endTime": { + "readOnly": true, + "type": "string", + "description": "The end time of script action execution." + }, + "status": { + "readOnly": true, + "type": "string", + "description": "The current execution status of the script action." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "The reason why the script action was executed." + }, + "executionSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ScriptActionExecutionSummary" + }, + "x-ms-identifiers": [], + "description": "The summary of script action execution result." + }, + "debugInformation": { + "readOnly": true, + "type": "string", + "description": "The script action execution debug information." + } + }, + "description": "The execution details of a script action." + }, + "ClusterIdentity": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of cluster identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the cluster. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the cluster. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + }, + "description": "The list of user identities associated with the cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the cluster." + }, + "UserAssignedIdentity": { + "type": "object", + "description": "The User Assigned Identity", + "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." + }, + "tenantId": { + "type": "string", + "description": "The tenant id of user assigned identity." + } + } + }, + "ClusterListResult": { + "type": "object", + "properties": { + "value": { + "description": "The list of Clusters.", + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + }, + "description": "The List Cluster operation response." + }, + "ClusterResizeParameters": { + "type": "object", + "properties": { + "targetInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The target instance count for the operation." + } + }, + "description": "The Resize Cluster request parameters." + }, + "ClusterDiskEncryptionParameters": { + "type": "object", + "properties": { + "vaultUri": { + "type": "string", + "description": "Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net" + }, + "keyName": { + "type": "string", + "description": "Key name that is used for enabling disk encryption." + }, + "keyVersion": { + "type": "string", + "description": "Specific key version that is used for enabling disk encryption." + } + }, + "description": "The Disk Encryption Cluster request parameters." + }, + "DiskEncryptionProperties": { + "type": "object", + "description": "The disk encryption properties", + "properties": { + "vaultUri": { + "type": "string", + "description": "Base key vault URI where the customers key is located eg. https://myvault.vault.azure.net" + }, + "keyName": { + "type": "string", + "description": "Key name that is used for enabling disk encryption." + }, + "keyVersion": { + "type": "string", + "description": "Specific key version that is used for enabling disk encryption." + }, + "encryptionAlgorithm": { + "type": "string", + "description": "Algorithm identifier for encryption, default RSA-OAEP.", + "enum": [ + "RSA-OAEP", + "RSA-OAEP-256", + "RSA1_5" + ], + "x-ms-enum": { + "name": "JsonWebKeyEncryptionAlgorithm", + "modelAsString": true + } + }, + "msiResourceId": { + "type": "string", + "description": "Resource ID of Managed Identity that is used to access the key vault." + }, + "encryptionAtHost": { + "type": "boolean", + "default": false, + "description": "Indicates whether or not resource disk encryption is enabled." + } + } + }, + "EncryptionInTransitProperties": { + "type": "object", + "description": "The encryption-in-transit properties.", + "properties": { + "isEncryptionInTransitEnabled": { + "type": "boolean", + "default": false, + "description": "Indicates whether or not inter cluster node communication is encrypted in transit." + } + } + }, + "UpdateGatewaySettingsParameters": { + "type": "object", + "properties": { + "restAuthCredential.isEnabled": { + "type": "boolean", + "default": true, + "x-ms-client-name": "isCredentialEnabled", + "description": "Indicates whether or not the gateway settings based authorization is enabled." + }, + "restAuthCredential.username": { + "type": "string", + "x-ms-client-name": "userName", + "description": "The gateway settings user name." + }, + "restAuthCredential.password": { + "type": "string", + "x-ms-client-name": "password", + "description": "The gateway settings user password." + } + }, + "description": "The update gateway settings request parameters." + }, + "GatewaySettings": { + "type": "object", + "properties": { + "restAuthCredential.isEnabled": { + "type": "string", + "x-ms-client-name": "isCredentialEnabled", + "description": "Indicates whether or not the gateway settings based authorization is enabled.", + "readOnly": true + }, + "restAuthCredential.username": { + "type": "string", + "x-ms-client-name": "userName", + "description": "The gateway settings user name.", + "readOnly": true + }, + "restAuthCredential.password": { + "type": "string", + "x-ms-client-name": "password", + "description": "The gateway settings user password.", + "readOnly": true + } + }, + "description": "Gateway settings." + }, + "AsyncOperationResult": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "The async operation state.", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "AsyncOperationState", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/Errors", + "description": "The operation error information." + } + }, + "description": "The azure async operation response." + }, + "UpdateClusterIdentityCertificateParameters": { + "type": "object", + "description": "The update cluster identity certificate request parameters.", + "properties": { + "applicationId": { + "description": "The application id.", + "type": "string" + }, + "certificate": { + "description": "The certificate in base64 encoded format.", + "type": "string" + }, + "certificatePassword": { + "description": "The password of the certificate.", + "type": "string" + } + } + }, + "PrivateLinkConfiguration": { + "type": "object", + "description": "The private link configuration.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The private link configuration id." + }, + "name": { + "type": "string", + "description": "The name of private link configuration." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the private link configuration." + }, + "properties": { + "$ref": "#/definitions/PrivateLinkConfigurationProperties", + "description": "The private link configuration properties.", + "x-ms-client-flatten": true + } + }, + "required": [ + "name", + "properties" + ] + }, + "PrivateLinkConfigurationProperties": { + "type": "object", + "description": "The private link configuration properties.", + "properties": { + "groupId": { + "type": "string", + "description": "The HDInsight private linkable sub-resource name to apply the private link configuration to. For example, 'headnode', 'gateway', 'edgenode'." + }, + "provisioningState": { + "type": "string", + "description": "The private link configuration provisioning state, which only appears in the response.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "Canceled", + "Deleting" + ], + "x-ms-enum": { + "name": "PrivateLinkConfigurationProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "ipConfigurations": { + "type": "array", + "description": "The IP configurations for the private link service.", + "items": { + "$ref": "#/definitions/IPConfiguration" + } + } + }, + "required": [ + "groupId", + "ipConfigurations" + ] + }, + "IPConfiguration": { + "type": "object", + "description": "The ip configurations for the private link service.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The private link IP configuration id." + }, + "name": { + "type": "string", + "description": "The name of private link IP configuration." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the private link IP configuration." + }, + "properties": { + "$ref": "#/definitions/IPConfigurationProperties", + "description": "The private link ip configuration properties.", + "x-ms-client-flatten": true + } + }, + "required": [ + "name" + ] + }, + "IPConfigurationProperties": { + "type": "object", + "description": "The private link ip configuration properties.", + "properties": { + "provisioningState": { + "type": "string", + "description": "The private link configuration provisioning state, which only appears in the response.", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "Canceled", + "Deleting" + ], + "x-ms-enum": { + "name": "PrivateLinkConfigurationProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "primary": { + "type": "boolean", + "description": "Indicates whether this IP configuration is primary for the corresponding NIC." + }, + "privateIPAddress": { + "type": "string", + "description": "The IP address." + }, + "privateIPAllocationMethod": { + "type": "string", + "description": "The method that private IP address is allocated.", + "enum": [ + "dynamic", + "static" + ], + "x-ms-enum": { + "name": "PrivateIPAllocationMethod", + "modelAsString": true + } + }, + "subnet": { + "$ref": "#/definitions/ResourceId", + "description": "The subnet resource id." + } + } + }, + "ResourceId": { + "type": "object", + "description": "The azure resource id.", + "properties": { + "id": { + "type": "string", + "description": "The azure resource id." + } + } + }, + "Resource": { + "type": "object", + "description": "Common fields that are returned in the response for all Azure Resource Manager resources", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "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\"" + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The long running operation id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/configurations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/configurations.json new file mode 100644 index 000000000000..783ff79a0d5a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/configurations.json @@ -0,0 +1,250 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2023-04-15-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/clusters/{clusterName}/configurations": { + "post": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_List", + "description": "Gets all configuration information for an HDI cluster.", + "x-ms-examples": { + "Get all configuration information": { + "$ref": "./examples/HDI_Configurations_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterConfigurations" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/configurations/{configurationName}": { + "post": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Update", + "description": "Configures the HTTP settings on the specified cluster. This API is deprecated, please use UpdateGatewaySettings in cluster endpoint instead.", + "deprecated": true, + "x-ms-examples": { + "Enable HTTP connectivity": { + "$ref": "./examples/ChangeHttpConnectivityEnable.json" + }, + "Disable HTTP connectivity": { + "$ref": "./examples/ChangeHttpConnectivityDisable.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + }, + "description": "The cluster configurations." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition" + }, + "202": { + "description": "Accepted response definition" + }, + "204": { + "description": "No content response definition" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Configurations" + ], + "operationId": "Configurations_Get", + "description": "The configuration object for the specified cluster. This API is not recommended and might be removed in the future. Please consider using List configurations API instead.", + "x-ms-examples": { + "Get Core site settings": { + "$ref": "./examples/HDI_Configurations_Get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ConfigurationNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterConfiguration" + } + } + } + } + } + }, + "definitions": { + "ClusterConfiguration": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The configuration object for the specified configuration for the specified cluster." + }, + "ClusterConfigurations": { + "type": "object", + "properties": { + "configurations": { + "description": "The configuration object for the specified configuration for the specified cluster.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ClusterConfiguration" + } + } + }, + "description": "The configuration object for the specified cluster." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ConfigurationNameParameter": { + "name": "configurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster configuration.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ApprovePrivateEndpointConnection.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ApprovePrivateEndpointConnection.json new file mode 100644 index 000000000000..2bd8e25c224c --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ApprovePrivateEndpointConnection.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "privateEndpointConnectionName": "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "update it from pending to approved.", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateEndpointConnections/testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "name": "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "type": "Microsoft.HDInsight/clusters/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testprivateep" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "update it from pending to approved.", + "actionsRequired": "None" + }, + "linkIdentifier": "620815036", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateEndpointConnections/testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "name": "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "type": "Microsoft.HDInsight/clusters/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testprivateep" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "update it from pending to approved.", + "actionsRequired": "None" + }, + "linkIdentifier": "620815036", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ChangeHttpConnectivityDisable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ChangeHttpConnectivityDisable.json new file mode 100644 index 000000000000..17f61c086232 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ChangeHttpConnectivityDisable.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "configurationName": "gateway", + "parameters": { + "restAuthCredential.isEnabled": "false" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ChangeHttpConnectivityEnable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ChangeHttpConnectivityEnable.json new file mode 100644 index 000000000000..5c4b3d64b9ec --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ChangeHttpConnectivityEnable.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "configurationName": "gateway", + "parameters": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "hadoop", + "restAuthCredential.password": "**********" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateApplication.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateApplication.json new file mode 100644 index 000000000000..3abee0230746 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateApplication.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "applicationName": "hue", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "computeProfile": { + "roles": [ + { + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + } + ] + }, + "installScriptActions": [ + { + "name": "app-install-app1", + "uri": "https://.../install.sh", + "parameters": "-version latest -port 20000", + "roles": [ + "edgenode" + ] + } + ], + "uninstallScriptActions": [], + "httpsEndpoints": [ + { + "subDomainSuffix": "dss", + "destinationPort": 20000, + "accessModes": [ + "WebPage" + ] + } + ], + "applicationType": "CustomApplication", + "errors": [] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/hue", + "name": "hue", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "etag", + "tags": {}, + "properties": { + "computeProfile": { + "roles": [ + { + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + } + ] + }, + "installScriptActions": [ + { + "name": "app-install-app1", + "uri": "https://.../install.sh", + "roles": [ + "edgenode" + ] + } + ], + "uninstallScriptActions": [], + "httpsEndpoints": [ + { + "destinationPort": 20000, + "accessModes": [ + "WebPage" + ] + } + ], + "sshEndpoints": [], + "provisioningState": "InProgress", + "applicationState": "ApplicationConfiguration", + "applicationType": "CustomApplication", + "errors": [], + "createdDate": "2017-02-28" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateExtension.json new file mode 100644 index 000000000000..635328f5c351 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateExtension.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring", + "parameters": { + "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", + "primaryKey": "**********" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAutoscaleConfig.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAutoscaleConfig.json new file mode 100644 index 000000000000..ff503e52b977 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAutoscaleConfig.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "hadoop", + "componentVersion": { + "Hadoop": "2.7" + }, + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "hdinsight-autoscale-tes-2019-06-18t05-49-16-591z", + "key": "storagekey", + "enableSecureChannel": true + } + ] + }, + "computeProfile": { + "roles": [ + { + "autoscale": { + "capacity": null, + "recurrence": { + "timeZone": "China Standard Time", + "schedule": [ + { + "days": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "timeAndCapacity": { + "time": "09:00", + "minInstanceCount": 3, + "maxInstanceCount": 3 + } + }, + { + "days": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday" + ], + "timeAndCapacity": { + "time": "18:00", + "minInstanceCount": 6, + "maxInstanceCount": 6 + } + }, + { + "days": [ + "Saturday", + "Sunday" + ], + "timeAndCapacity": { + "time": "09:00", + "minInstanceCount": 2, + "maxInstanceCount": 2 + } + }, + { + "days": [ + "Saturday", + "Sunday" + ], + "timeAndCapacity": { + "time": "18:00", + "minInstanceCount": 4, + "maxInstanceCount": 4 + } + } + ] + } + }, + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D4_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + }, + "virtualNetworkProfile": null, + "scriptActions": [], + "dataDisksGroups": null + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "East US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "properties": { + "clusterVersion": "4.0.1000.1", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-4.0.1000.1.1910270459.json", + "kind": "HADOOP", + "componentVersion": { + "Hadoop": "3.1" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d12_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "standard_d4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a2_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2019-11-18T12:25:43.48", + "quotaInfo": { + "coresUsed": 40 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAvailabilityZones.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAvailabilityZones.json new file mode 100644 index 000000000000..2bec3f0ea7bd --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithAvailabilityZones.json @@ -0,0 +1,195 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subId", + "parameters": { + "zones": [ + "1" + ], + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "clusterDefinition": { + "kind": "hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + }, + "ambari-conf": { + "database-server": "{sql server name}.database.windows.net", + "database-name": "{ambari database name}", + "database-user-name": "**********", + "database-user-password": "**********" + }, + "hive-site": { + "javax.jdo.option.ConnectionURL": "jdbc:sqlserver://{sql server name}.database.windows.net;database={hive metastore name};encrypt=true;trustServerCertificate=true;create=false;loginTimeout=300;sendStringParametersAsUnicode=true;prepareSQL=0", + "javax.jdo.option.ConnectionUserName": "**********", + "javax.jdo.option.ConnectionPassword": "**********!", + "javax.jdo.option.ConnectionDriverName": "com.microsoft.sqlserver.jdbc.SQLServerDriver" + }, + "hive-env": { + "hive_database": "Existing MSSQL Server database with SQL authentication", + "hive_database_name": "{hive metastore name}", + "hive_database_type": "mssql", + "hive_existing_mssql_server_database": "{hive metastore name}", + "hive_existing_mssql_server_host": "{sql server name}.database.windows.net", + "hive_hostname": "{sql server name}.database.windows.net" + }, + "oozie-site": { + "oozie.service.JPAService.jdbc.url": "jdbc:sqlserver://{sql server name}.database.windows.net;database={oozie metastore name};encrypt=true;trustServerCertificate=true;create=false;loginTimeout=300;sendStringParametersAsUnicode=true;prepareSQL=0", + "oozie.service.JPAService.jdbc.username": "**********", + "oozie.service.JPAService.jdbc.password": "**********", + "oozie.service.JPAService.jdbc.driver": "com.microsoft.sqlserver.jdbc.SQLServerDriver", + "oozie.db.schema.name": "oozie" + }, + "oozie-env": { + "oozie_database": "Existing MSSQL Server database with SQL authentication", + "oozie_database_name": "{oozie metastore name}", + "oozie_database_type": "mssql", + "oozie_existing_mssql_server_database": "{oozie metastore name}", + "oozie_existing_mssql_server_host": "{sql server name}.database.windows.net", + "oozie_hostname": "{sql server name}.database.windows.net" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage", + "isDefault": true, + "container": "containername", + "key": "storage account key", + "enableSecureChannel": true + } + ] + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + }, + { + "name": "workernode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "South Central US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "tags": null, + "zones": [ + "1" + ], + "properties": { + "clusterVersion": "3.6.1000.67", + "osType": "Linux", + "clusterId": "8186508b6234470e9d16c9e8e13bd821", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.6.1000.67.2005040905.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + }, + { + "name": "workernode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2020-06-09T12:25:43.48", + "quotaInfo": { + "coresUsed": 16 + }, + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithComputeIsolationProperties.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithComputeIsolationProperties.json new file mode 100644 index 000000000000..65610796a0f8 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithComputeIsolationProperties.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subId", + "parameters": { + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "clusterDefinition": { + "kind": "hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage", + "isDefault": true, + "container": "containername", + "key": "storage account key", + "enableSecureChannel": true + } + ] + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + } + } + ] + }, + "computeIsolationProperties": { + "enableComputeIsolation": true, + "hostSku": null + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "South Central US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "tags": null, + "properties": { + "clusterVersion": "3.6.1000.67", + "osType": "Linux", + "clusterId": "8186508b6234470e9d16c9e8e13bd821", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.6.1000.67.2005040905.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + }, + { + "name": "workernode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "computeIsolationProperties": { + "enableComputeIsolation": true, + "hostSku": null + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2020-06-09T12:25:43.48", + "quotaInfo": { + "coresUsed": 16 + }, + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithCustomNetworkProperties.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithCustomNetworkProperties.json new file mode 100644 index 000000000000..11b1ba7b8b8a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithCustomNetworkProperties.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subId", + "parameters": { + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "clusterDefinition": { + "kind": "hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage", + "isDefault": true, + "container": "containername", + "key": "storage account key", + "enableSecureChannel": true + } + ] + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + }, + { + "name": "workernode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + } + ] + }, + "networkProperties": { + "resourceProviderConnection": "Outbound", + "privateLink": "Enabled" + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "South Central US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "tags": null, + "properties": { + "clusterVersion": "3.6.1000.67", + "osType": "Linux", + "clusterId": "8186508b6234470e9d16c9e8e13bd821", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.6.1000.67.2005040905.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + }, + { + "name": "workernode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + } + ] + }, + "networkProperties": { + "resourceProviderConnection": "Outbound", + "privateLink": "Enabled" + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2020-06-09T12:25:43.48", + "quotaInfo": { + "coresUsed": 16 + }, + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionAtHost.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionAtHost.json new file mode 100644 index 000000000000..6659e572fcbc --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionAtHost.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_DS14_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Standard_DS14_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Standard_DS14_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "default8525", + "key": "storagekey", + "enableSecureChannel": true + } + ] + }, + "diskEncryptionProperties": { + "encryptionAtHost": true + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "South Central US", + "etag": "3b76ce3d-892c-4036-9d8b-8ade18ba7a4b", + "tags": null, + "properties": { + "clusterVersion": "3.6.1000.67", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.6.1000.67.2001080246.json", + "kind": "Hadoop", + "componentVersion": { + "Hadoop": "2.7" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_ds14_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_ds14_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_ds14_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2020-01-10T08:36:39.153", + "quotaInfo": { + "coresUsed": 20 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard", + "diskEncryptionProperties": { + "vaultUri": null, + "keyName": null, + "keyVersion": null, + "encryptionAlgorithm": null, + "msiResourceId": null, + "encryptionAtHost": true + } + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json new file mode 100644 index 000000000000..8b80ffdedf04 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Large" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Large" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "default8525", + "key": "storagekey", + "enableSecureChannel": true + } + ] + }, + "encryptionInTransitProperties": { + "isEncryptionInTransitEnabled": true + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "South Central US", + "etag": "3b76ce3d-892c-4036-9d8b-8ade18ba7a4b", + "tags": null, + "properties": { + "clusterVersion": "3.6.1000.67", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.6.1000.67.2001080246.json", + "kind": "Hadoop", + "componentVersion": { + "Hadoop": "2.7" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_a4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a2_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2020-01-10T08:36:39.153", + "quotaInfo": { + "coresUsed": 20 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard", + "encryptionInTransitProperties": { + "isEncryptionInTransitEnabled": true + } + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithTLS12.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithTLS12.json new file mode 100644 index 000000000000..cd6e1b15e2f7 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateHDInsightClusterWithTLS12.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Large" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Large" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "default8525", + "key": "storagekey", + "enableSecureChannel": true + } + ] + }, + "minSupportedTlsVersion": "1.2" + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "South Central US", + "etag": "3b76ce3d-892c-4036-9d8b-8ade18ba7a4b", + "tags": null, + "properties": { + "clusterVersion": "3.6.1000.67", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.6.1000.67.2001080246.json", + "kind": "Hadoop", + "componentVersion": { + "Hadoop": "2.7" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_a4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a2_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2020-01-10T08:36:39.153", + "quotaInfo": { + "coresUsed": 20 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard", + "minSupportedTlsVersion": "1.2" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateKafkaClusterWithKafkaRestProxy.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateKafkaClusterWithKafkaRestProxy.json new file mode 100644 index 000000000000..241dd6002db7 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateKafkaClusterWithKafkaRestProxy.json @@ -0,0 +1,224 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clusterVersion": "4.0", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "kafka", + "componentVersion": { + "Kafka": "2.1" + }, + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "kafkaRestProperties": { + "clientGroupInfo": { + "groupName": "Kafka security group name", + "groupId": "00000000-0000-0000-0000-111111111111" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Large" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Large" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + }, + "dataDisksGroups": [ + { + "disksPerNode": 8 + } + ] + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "kafkamanagementnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "kafkauser", + "password": "**********" + } + } + } + ] + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "containername", + "key": "storagekey", + "enableSecureChannel": true + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "South Central US", + "etag": "e1266b83-9bda-4797-a906-1bf82c8eb09a", + "tags": null, + "properties": { + "clusterVersion": "4.0.1000.1", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/kafka-4.0.1000.1.1911212244.json", + "kind": "KAFKA", + "componentVersion": { + "Kafka": "2.1" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "standard_d3_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + }, + "dataDisksGroups": [ + { + "disksPerNode": 2, + "storageAccountType": "Standard_LRS", + "diskSizeGB": 1023 + } + ] + }, + { + "name": "kafkamanagementnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2019-11-25T03:43:23.663", + "quotaInfo": { + "coresUsed": 52 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + }, + { + "name": "KafkaRestProxyPublicEndpoint", + "protocol": "TCP", + "location": "cluster1-kafkarest.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard", + "kafkaRestProperties": { + "clientGroupInfo": { + "groupName": "security group name", + "groupId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopAdlsGen2.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopAdlsGen2.json new file mode 100644 index 000000000000..030f0b560c63 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopAdlsGen2.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.dfs.core.windows.net", + "isDefault": true, + "fileSystem": "default", + "key": "storagekey", + "enableSecureChannel": true + } + ] + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "East US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "properties": { + "clusterVersion": "4.0.1000.1", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-4.0.1000.1.1910270459.json", + "kind": "HADOOP", + "componentVersion": { + "Hadoop": "3.1" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d12_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "standard_d4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a2_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2019-11-18T12:25:43.48", + "quotaInfo": { + "coresUsed": 40 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSecureHadoop.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSecureHadoop.json new file mode 100644 index 000000000000..362532e6bf61 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSecureHadoop.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.5", + "osType": "Linux", + "tier": "Premium", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "containername", + "key": "storage account key", + "enableSecureChannel": true + } + ] + }, + "securityProfile": { + "directoryType": "ActiveDirectory", + "domain": "DomainName", + "organizationalUnitDN": "OU=Hadoop,DC=hdinsight,DC=test", + "ldapsUrls": [ + "ldaps://10.10.0.4:636" + ], + "domainUsername": "DomainUsername", + "domainUserPassword": "**********", + "clusterUsersGroupDNs": [ + "hdiusers" + ] + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + }, + "scriptActions": [] + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + }, + "scriptActions": [] + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + }, + "scriptActions": [] + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "East US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "properties": { + "clusterVersion": "4.0.1000.1", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-4.0.1000.1.1910270459.json", + "kind": "HADOOP", + "componentVersion": { + "Hadoop": "3.1" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d12_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "standard_d4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a2_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2019-11-18T12:25:43.48", + "quotaInfo": { + "coresUsed": 40 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSshPassword.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSshPassword.json new file mode 100644 index 000000000000..529c220c982a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSshPassword.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.5", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "containername", + "key": "storagekey", + "enableSecureChannel": true + } + ] + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "East US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "properties": { + "clusterVersion": "4.0.1000.1", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-4.0.1000.1.1910270459.json", + "kind": "HADOOP", + "componentVersion": { + "Hadoop": "3.1" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d12_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "standard_d4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a2_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2019-11-18T12:25:43.48", + "quotaInfo": { + "coresUsed": 40 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSshPublicKey.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSshPublicKey.json new file mode 100644 index 000000000000..40cd766bd6f3 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxHadoopSshPublicKey.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.5", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "containername", + "key": "storagekey", + "enableSecureChannel": true + } + ] + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "East US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "properties": { + "clusterVersion": "4.0.1000.1", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-4.0.1000.1.1910270459.json", + "kind": "HADOOP", + "componentVersion": { + "Hadoop": "3.1" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d12_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "standard_d4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a2_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2019-11-18T12:25:43.48", + "quotaInfo": { + "coresUsed": 40 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxSparkSshPassword.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxSparkSshPassword.json new file mode 100644 index 000000000000..77c4fcfff986 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/CreateLinuxSparkSshPassword.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.5", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Spark", + "componentVersion": { + "Spark": "2.0" + }, + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "containername", + "key": "storageapikey*", + "enableSecureChannel": true + } + ] + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D12_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "minInstanceCount": 1, + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D4_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/azureasyncoperations/create?api-version=2023-04-15-preview" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "East US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "properties": { + "clusterVersion": "4.0.1000.1", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-4.0.1000.1.1910270459.json", + "kind": "SPARK", + "componentVersion": { + "Hadoop": "3.1" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d12_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "standard_d4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a2_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2019-11-18T12:25:43.48", + "quotaInfo": { + "coresUsed": 40 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteApplication.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteApplication.json new file mode 100644 index 000000000000..0dafa2eb62a7 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteApplication.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "applicationName": "hue", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteExtension.json new file mode 100644 index 000000000000..f708cc0560c7 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteExtension.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteLinuxHadoopCluster.json new file mode 100644 index 000000000000..ea4ccf420d95 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteLinuxHadoopCluster.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "200": {}, + "204": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeletePrivateEndpointConnection.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..ad06710dc29a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeletePrivateEndpointConnection.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "privateEndpointConnectionName": "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteScriptAction.json new file mode 100644 index 000000000000..33fec3fc27a4 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DeleteScriptAction.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "scriptName": "scriptName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableClusterAutoScale.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableClusterAutoScale.json new file mode 100644 index 000000000000..8b88e8c2506b --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableClusterAutoScale.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "roleName": "workernode", + "parameters": {} + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableLinuxClusterAzureMonitor.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableLinuxClusterAzureMonitor.json new file mode 100644 index 000000000000..f1493a293958 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableLinuxClusterAzureMonitor.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableLinuxClusterMonitoring.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableLinuxClusterMonitoring.json new file mode 100644 index 000000000000..f1493a293958 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/DisableLinuxClusterMonitoring.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "204": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableLinuxClusterAzureMonitor.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableLinuxClusterAzureMonitor.json new file mode 100644 index 000000000000..04d918b91b5c --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableLinuxClusterAzureMonitor.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", + "primaryKey": "**********" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableLinuxClusterMonitoring.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableLinuxClusterMonitoring.json new file mode 100644 index 000000000000..04d918b91b5c --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableLinuxClusterMonitoring.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "workspaceId": "a2090ead-8c9f-4fba-b70e-533e3e003163", + "primaryKey": "**********" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableOrUpdateAutoScaleWithLoadBasedConfiguration.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableOrUpdateAutoScaleWithLoadBasedConfiguration.json new file mode 100644 index 000000000000..77576ac8870d --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableOrUpdateAutoScaleWithLoadBasedConfiguration.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "roleName": "workernode", + "parameters": { + "autoscale": { + "capacity": { + "minInstanceCount": 3, + "maxInstanceCount": 5 + } + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableOrUpdateAutoScaleWithScheduleBasedConfiguration.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableOrUpdateAutoScaleWithScheduleBasedConfiguration.json new file mode 100644 index 000000000000..c6730965c4df --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/EnableOrUpdateAutoScaleWithScheduleBasedConfiguration.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "roleName": "workernode", + "parameters": { + "autoscale": { + "recurrence": { + "timeZone": "China Standard Time", + "schedule": [ + { + "days": [ + "Thursday" + ], + "timeAndCapacity": { + "time": "16:00", + "minInstanceCount": 4, + "maxInstanceCount": 4 + } + } + ] + } + } + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllApplications.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllApplications.json new file mode 100644 index 000000000000..b33ebb8a6143 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllApplications.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", + "tags": { + "key1": "val1" + }, + "properties": { + "computeProfile": { + "roles": [ + { + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + } + ] + }, + "installScriptActions": [ + { + "name": "app-install-app", + "uri": "http://testurl.com/public/hdi-app/20170301/hdinsight-app-install.sh", + "roles": [ + "edgenode" + ] + } + ], + "uninstallScriptActions": [], + "httpsEndpoints": [ + { + "accessModes": [ + "WebPage" + ], + "location": "https://cluster1-app.apps.azurehdinsight.net:443", + "destinationPort": 20000, + "publicPort": 443 + } + ], + "sshEndpoints": [ + { + "location": "app.cluster1-ssh.azurehdinsight.net:22", + "destinationPort": 22, + "publicPort": 22 + } + ], + "provisioningState": "Succeeded", + "applicationState": "Running", + "createdDate": "2017-03-22T21:34:39.293", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "app-on-hdiapp-on-hdi.1.0.3" + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app2", + "name": "app2", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", + "tags": { + "key1": "val1" + }, + "properties": { + "computeProfile": { + "roles": [ + { + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D3" + } + } + ] + }, + "installScriptActions": [ + { + "name": "app2-Install", + "uri": "https://app2url.com/azure/2.4.0.0/app2_install.sh", + "roles": [ + "edgenode" + ] + } + ], + "uninstallScriptActions": [], + "httpsEndpoints": [ + { + "accessModes": [ + "WebPage" + ], + "location": "location", + "destinationPort": 18630, + "publicPort": 443 + } + ], + "sshEndpoints": [], + "provisioningState": "InProgress", + "applicationState": "AzureVMConfiguration", + "createdDate": "2017-03-28T02:01:25.107", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "app2-hdinsightsmall.1.0.8" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllPrivateEndpointConnectionsInCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllPrivateEndpointConnectionsInCluster.json new file mode 100644 index 000000000000..5f5cde2003a9 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllPrivateEndpointConnectionsInCluster.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateEndpointConnections/testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "name": "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "type": "Microsoft.HDInsight/clusters/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testprivateep" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "", + "actionsRequired": "None" + }, + "linkIdentifier": "620815036", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllPrivateLinkResourcesInCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllPrivateLinkResourcesInCluster.json new file mode 100644 index 000000000000..dda0be802c27 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetAllPrivateLinkResourcesInCluster.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateLinkResources/gateway", + "name": "gateway", + "type": "Microsoft.HDInsight/clusters/privateLinkResources", + "properties": { + "groupId": "gateway", + "requiredMembers": [ + "gateway" + ], + "requiredZoneNames": [ + "privatelink.azurehdinsight.net" + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateLinkResources/headnode", + "name": "headnode", + "type": "Microsoft.HDInsight/clusters/privateLinkResources", + "properties": { + "groupId": "headnode", + "requiredMembers": [ + "headnode" + ], + "requiredZoneNames": [ + "privatelink.azurehdinsight.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationCreated.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationCreated.json new file mode 100644 index 000000000000..c77a2cd8d50f --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationCreated.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "applicationName": "app", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC", + "tags": { + "key1": "val1" + }, + "properties": { + "computeProfile": { + "roles": [ + { + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D12_v2" + } + } + ] + }, + "installScriptActions": [ + { + "name": "app-install", + "uri": "http://app.com/public/hdi-app/20170301/app-install.sh", + "roles": [ + "edgenode" + ] + } + ], + "uninstallScriptActions": [], + "httpsEndpoints": [ + { + "accessModes": [ + "WebPage" + ], + "location": "https://cluster1.apps.azurehdinsight.net:443", + "destinationPort": 20000, + "publicPort": 443 + } + ], + "sshEndpoints": [ + { + "location": "cluster1-ssh.azurehdinsight.net:22", + "destinationPort": 22, + "publicPort": 22 + } + ], + "provisioningState": "Succeeded", + "applicationState": "Running", + "createdDate": "2017-03-22T21:34:39.293", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "appMarketId" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationCreationAsyncOperationStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationCreationAsyncOperationStatus.json new file mode 100644 index 000000000000..4ea1d5d05beb --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationCreationAsyncOperationStatus.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "applicationName": "app", + "operationId": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationInProgress.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationInProgress.json new file mode 100644 index 000000000000..4483bf09d8f0 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetApplicationInProgress.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "applicationName": "app", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/applications/app", + "name": "app", + "type": "Microsoft.HDInsight/clusters/applications", + "etag": "2C128F8E-BB26-4637-99E4-18EBC39FD51F", + "tags": { + "key1": "val1" + }, + "properties": { + "computeProfile": { + "roles": [ + { + "name": "edgenode", + "targetInstanceCount": 1, + "hardwareProfile": { + "vmSize": "Standard_D3" + } + } + ] + }, + "installScriptActions": [ + { + "name": "app-Install", + "uri": "https://app.com/azure/app_install.sh", + "roles": [ + "edgenode" + ] + } + ], + "uninstallScriptActions": [], + "httpsEndpoints": [ + { + "accessModes": [ + "WebPage" + ], + "location": "location", + "destinationPort": 18630, + "publicPort": 443 + } + ], + "sshEndpoints": [], + "provisioningState": "InProgress", + "applicationState": "AzureVMConfiguration", + "createdDate": "2017-03-28T02:01:25.107", + "applicationType": "CustomApplication", + "marketplaceIdentifier": "id" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetClusterCreatingAsyncOperationStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetClusterCreatingAsyncOperationStatus.json new file mode 100644 index 000000000000..4b23f028a42a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetClusterCreatingAsyncOperationStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "operationId": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetClusterVirtualMachines.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetClusterVirtualMachines.json new file mode 100644 index 000000000000..1e885ea89cf4 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetClusterVirtualMachines.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "clusterName": "cluster1" + }, + "responses": { + "200": { + "body": [ + { + "name": "gateway1" + }, + { + "name": "gateway3" + }, + { + "name": "headnode0" + }, + { + "name": "headnode3" + }, + { + "name": "workernode0" + }, + { + "name": "workernode1" + }, + { + "name": "zookeepernode0" + }, + { + "name": "zookeepernode2" + }, + { + "name": "zookeepernode3" + } + ] + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetExtension.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetExtension.json new file mode 100644 index 000000000000..bdb490fe6475 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetExtension.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "extensionName": "clustermonitoring" + }, + "responses": { + "200": { + "body": { + "clusterMonitoringEnabled": true, + "workspaceId": "id" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetExtensionCreationAsyncOperationStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetExtensionCreationAsyncOperationStatus.json new file mode 100644 index 000000000000..34f54a3d8d79 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetExtensionCreationAsyncOperationStatus.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "extensionName": "azuremonitor", + "operationId": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetHDInsightCapabilities.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetHDInsightCapabilities.json new file mode 100644 index 000000000000..2f7d70ed6bd6 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetHDInsightCapabilities.json @@ -0,0 +1,384 @@ +{ + "parameters": { + "location": "West US", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "versions": { + "paas": { + "available": [ + { + "friendlyName": "1.6", + "displayName": "HdInsight version 1.6.1.0.335536", + "isDefault": false + }, + { + "friendlyName": "2.1", + "displayName": "Version 2.1.9.406.1221105", + "isDefault": false, + "componentVersions": { + "HDP": "1.3", + "Hadoop": "1.2.0" + } + }, + { + "friendlyName": "3.0", + "displayName": "Version 3.0.6.989.2441725", + "isDefault": false, + "componentVersions": { + "HDP": "2.0", + "Hadoop": "2.2.0" + } + }, + { + "friendlyName": "3.1", + "displayName": "Version 3.1.4.989.2441725", + "isDefault": false, + "componentVersions": { + "HDP": "2.1.7", + "Hadoop": "2.4.0", + "HBase": "0.98" + } + }, + { + "friendlyName": "3.2", + "displayName": "Version 3.2.7.989.2441725", + "isDefault": false, + "componentVersions": { + "HDP": "2.2", + "Hadoop": "2.6.0", + "HBase": "0.98.4", + "Storm": "0.9.3" + } + }, + { + "friendlyName": "3.3", + "displayName": "Version 3.3.0.989.2441725", + "isDefault": true, + "componentVersions": { + "HDP": "2.3", + "Hadoop": "2.7.0", + "HBase": "1.1.2", + "Storm": "0.10.0" + } + } + ] + }, + "iaas": { + "available": [ + { + "friendlyName": "3.2", + "displayName": "Version 3.2.1000.0.8840373", + "isDefault": false, + "componentVersions": { + "HDP": "2.2", + "Hadoop": "2.6.0", + "HBase": "0.98.4", + "Storm": "0.9.3" + } + }, + { + "friendlyName": "3.3", + "displayName": "Version 3.3.1000.0.9776961", + "isDefault": false, + "componentVersions": { + "HDP": "2.3", + "Hadoop": "2.7.0", + "HBase": "1.1.2", + "Storm": "0.10.0", + "Spark": "1.5.2" + } + }, + { + "friendlyName": "3.4", + "displayName": "Version 3.4.1000.0.9719475", + "isDefault": false, + "componentVersions": { + "HDP": "2.4", + "Hadoop": "2.7.1", + "HBase": "1.1.2", + "Storm": "0.10.0", + "Spark": "1.6.2", + "RServer": "8.0" + } + }, + { + "friendlyName": "3.5", + "displayName": "Version 3.5.1000.0.9732704", + "isDefault": true, + "componentVersions": { + "HDP": "2.5", + "Hadoop": "2.7.3", + "InteractiveHive": "2.1.0", + "HBase": "1.1.2", + "Storm": "1.0.1", + "Spark": "1.6.3,2.0.2", + "RServer": "9.0" + } + }, + { + "friendlyName": "3.6", + "displayName": "Version 3.6.1000.0.9503998", + "isDefault": false, + "componentVersions": { + "HDP": "2.6", + "Spark": "2.1.0" + } + }, + { + "friendlyName": "99.152", + "displayName": "Version 99.152.1000.0.6943836", + "isDefault": false + } + ] + } + }, + "regions": { + "paas": { + "available": [ + "AUSTRALIA EAST", + "AUSTRALIA SOUTHEAST", + "BRAZIL SOUTH", + "CENTRAL INDIA", + "CENTRAL US", + "EAST ASIA", + "EAST US", + "EAST US 2", + "JAPAN EAST", + "JAPAN WEST", + "NORTH CENTRAL US", + "NORTH EUROPE", + "SOUTH CENTRAL US", + "SOUTHEAST ASIA", + "WEST EUROPE", + "WEST US", + "WEST US 2" + ] + }, + "iaas": { + "available": [ + "AUSTRALIA EAST", + "AUSTRALIA SOUTHEAST", + "BRAZIL SOUTH", + "CANADA CENTRAL", + "CANADA EAST", + "CENTRAL INDIA", + "CENTRAL US", + "CENTRAL US EUAP", + "EAST ASIA", + "EAST US", + "EAST US 2", + "JAPAN EAST", + "JAPAN WEST", + "NORTH CENTRAL US", + "NORTH EUROPE", + "SOUTH CENTRAL US", + "SOUTHEAST ASIA", + "WEST CENTRAL US", + "WEST EUROPE", + "WEST US", + "WEST US 2" + ] + } + }, + "features": [ + "ALLOW_GATEWAY_AUTH_BYPASS", + "AUX_IAAS_FUNCTIONALITIES", + "BLOCK_APPS_FOR_SECURE_CLUSTER", + "CLUSTER_RESIZE", + "CLUSTERS_CONTRACT_1", + "CLUSTERS_CONTRACT_1_SDK", + "CLUSTERS_CONTRACT_2_SDK", + "CLUSTERS_CONTRACT_VERSION_3_SDK", + "COLLECTANONYMIZEDLOGS", + "CONTAINER_LOG_COLLECTOR", + "CONTAINER_RESOURCE_V3", + "CUSTOM_ACTIONS_V2", + "DATALAKE", + "DATALAKE_3_2", + "DATALAKE_3_4", + "DATALAKE_3_5", + "DATALAKE_DEFAULTFS_3_5", + "DEFAULT_CONTAINER_IDENTIFIER_AND_STORAGEFQDN_ALREADY_USED", + "DOCUMENT_VALIDATION_IN_API", + "ENABLEDATALAKE", + "ENABLEGENEVAANALYTICS", + "HADOOP_VIRTUAL_NETWORK_ENABLED", + "HS2_ZK_ROUTER_INTERACTIVEHIVE", + "IAAS_ALLOW_CUSTOM_DNS", + "IAAS_AMBARI_APP_TIMELINE_SERVER_HA_SERVICE", + "IAAS_AMBARI_DEPENDENCY_BASED_DEPLOYMENT", + "IAAS_AMBARI_HA_SERVICES", + "IAAS_AMBARI_HISTORYSERVER_HA_SERVICE", + "IAAS_AMBARI_LOWER_LATENCY", + "IAAS_AMBARI_SKIP_COMPONENTS_INSTALL", + "IAAS_ARM_PROVISIONING", + "IAAS_CLOSE_HEAD_HTTPS_END_POINT_AFTER_CLUSTER_CREATE", + "IAAS_CLUSTER_APPLICATION_ALLOW_MULTIPLE_ROLE_INSTANCES", + "IAAS_CLUSTER_APPLICATION_REMOVE", + "IAAS_CLUSTER_CONTAINER_PREUPLOAD_SUBMIT_WAIT", + "IAAS_CLUSTER_RSERVER", + "IAAS_DB_CREATION_IN_PARALLEL_TO_VM", + "IAAS_DELETE_LEAKED_RESOURCES", + "IAAS_DEPLOYMENTS", + "IAAS_DO_NOT_CREATE_WASB_TABLES_IN_CUSTOMER_STORAGE", + "IAAS_ENABLE_CLUSTER_CONFIG_OVERRIDES", + "IAAS_ENABLE_OFFLINE_CLEANUP", + "IAAS_ENABLE_OFFLINE_CLEANUP_FOR_DELETING_VMS", + "IAAS_INCLUDE_STORAGE_IN_SUBSCRIPTION_SELECTION", + "IAAS_PARALLEL_DB_CREATE", + "IAAS_PREPROVISION_METASTORES_SCHEMAS", + "IAAS_SCRIPTACTIONS_DELETE_VMS_CRUD_FAILURES", + "IAAS_SCRIPTACTIONS_RUNNING", + "IAAS_SHORT_VM_NAME", + "IAAS_SUBMIT_AMBARI_REQUEST_ONCE_LINUX_VM_ARE_AVAILABLE", + "IAAS_TEZ_ATS_V15", + "IAAS_USE_UNATTENDED_UPGRADES_FOR_PATCHING", + "IAAS_VALIDATE_CUSTOM_VNET", + "IAAS_VALIDATE_NSG", + "IAAS_WAIT_FOR_CLOSING_HEAD_HTTPS_END_POINT_AFTER_CLUSTER_CREATE", + "IAAS_YARN_HDINSIGHT_SQL_TIMELINE_STORE", + "IAAS_YARN_HDINSIGHT_TIMELINE_STORE", + "INTERACTIVEHIVE", + "MDSCENTRALLOGGING", + "NODE_SETUP_POLLER_ENABLED", + "OVERPROVISION_HOSTGROUP_edgenode", + "OVERPROVISION_HOSTGROUP_Gateway", + "OVERPROVISION_HOSTGROUP_Workernode", + "OVERPROVISION_HOSTGROUP_zookeepernode", + "PERF_OPTIMIZED_RESOURCE_LOCATION_FETCH", + "PORTALAPPINSTALL", + "POWERSHELL_SCRIPT_ACTION", + "POWERSHELL_SCRIPT_ACTION_SDK", + "PREMIUM_TIER_PREVIEW", + "PROVISIONING_AGENT", + "RMHA", + "RSERVER_CLUSTERTYPE_3_5_ENABLED", + "RSERVER_CLUSTERTYPE_ENABLED", + "SHOW_HUMBOLDT_GA", + "SHOW_IBIZA_CREATE", + "SPARK_2_1", + "SPARK_EXPERIMENTAL", + "STORM_PREVIEW", + "UI_CREATE_WIZARD_V2", + "VIRTUAL_NETWORK_ENABLED", + "VMSIZES_AUX" + ], + "quota": { + "coresUsed": 0, + "maxCoresAllowed": 3000, + "regionalQuotas": [ + { + "regionName": "Australia East", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "Australia Southeast", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "Brazil South", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "Canada Central", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "Canada East", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "Central India", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "Central US", + "coresUsed": 24, + "coresAvailable": 1000 + }, + { + "regionName": "Central US EUAP", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "East Asia", + "coresUsed": 24, + "coresAvailable": 1000 + }, + { + "regionName": "East US", + "coresUsed": 24, + "coresAvailable": 1000 + }, + { + "regionName": "East US 2", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "Japan East", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "Japan West", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "North Central US", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "North Europe", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "South Central US", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "Southeast Asia", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "West Central US", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "West Europe", + "coresUsed": 0, + "coresAvailable": 1000 + }, + { + "regionName": "West US", + "coresUsed": 132, + "coresAvailable": 1000 + }, + { + "regionName": "West US 2", + "coresUsed": 0, + "coresAvailable": 1000 + } + ] + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetHDInsightUsages.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetHDInsightUsages.json new file mode 100644 index 000000000000..3daf56016bc9 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetHDInsightUsages.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "location": "West US", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 0, + "limit": 5000, + "name": { + "value": "cores", + "localizedValue": "Cores" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxClusterAzureMonitorStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxClusterAzureMonitorStatus.json new file mode 100644 index 000000000000..4020e83cf7d5 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxClusterAzureMonitorStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "clusterMonitoringEnabled": true, + "workspaceId": "id" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxClusterMonitoringStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxClusterMonitoringStatus.json new file mode 100644 index 000000000000..4020e83cf7d5 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxClusterMonitoringStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "clusterMonitoringEnabled": true, + "workspaceId": "id" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopAllClusters.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopAllClusters.json new file mode 100644 index 000000000000..1b8fe9c0cbea --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopAllClusters.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", + "name": "cluster2", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster2-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster2.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json new file mode 100644 index 000000000000..30ab326e8fc3 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopAllClustersInResourceGroup.json @@ -0,0 +1,173 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster2", + "name": "cluster2", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "pulkitssh" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster2-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster2.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopCluster.json new file mode 100644 index 000000000000..5361d5189dcd --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopCluster.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopScriptAction.json new file mode 100644 index 000000000000..9d147fe41066 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxHadoopScriptAction.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "app-Install", + "uri": "https://app.com/azure/app_install.sh", + "roles": [ + "edgenode" + ], + "applicationName": "app" + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxSparkCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxSparkCluster.json new file mode 100644 index 000000000000..42bec1fdd09c --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetLinuxSparkCluster.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "4cd8b5a9-ca9c-4239-9e5b-3916032e994c", + "tags": { + "key1": "val1" + }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/spark-3.5.1000.0.9625065.json", + "kind": "SPARK", + "componentVersion": { + "Spark": "2.0" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D12_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D4_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-03-03T08:35:07.323", + "quotaInfo": { + "coresUsed": 40 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetPrivateEndpointConnection.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetPrivateEndpointConnection.json new file mode 100644 index 000000000000..b7b337092313 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetPrivateEndpointConnection.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "privateEndpointConnectionName": "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateEndpointConnections/testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "name": "testprivateep.b3bf5fed-9b12-4560-b7d0-2abe1bba07e2", + "type": "Microsoft.HDInsight/clusters/privateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testprivateep" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "", + "actionsRequired": "None" + }, + "linkIdentifier": "620815036", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetPrivateLinkResource.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetPrivateLinkResource.json new file mode 100644 index 000000000000..a4677413abe5 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetPrivateLinkResource.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "privateLinkResourceName": "gateway", + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/privateLinkResources/gateway", + "name": "gateway", + "type": "Microsoft.HDInsight/clusters/privateLinkResources", + "properties": { + "groupId": "gateway", + "requiredMembers": [ + "gateway" + ], + "requiredZoneNames": [ + "privatelink.azurehdinsight.net" + ] + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetRestartHostsAsyncOperationStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetRestartHostsAsyncOperationStatus.json new file mode 100644 index 000000000000..4b23f028a42a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetRestartHostsAsyncOperationStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "operationId": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptActionById.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptActionById.json new file mode 100644 index 000000000000..1c7c05bb589e --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptActionById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": { + "body": { + "scriptExecutionId": 391145124054712, + "name": "Test", + "applicationName": "app1", + "uri": "http://testurl.com/install.ssh", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [], + "debugInformation": "" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptExecutionAsyncOperationStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptExecutionAsyncOperationStatus.json new file mode 100644 index 000000000000..4b23f028a42a --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptExecutionAsyncOperationStatus.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "operationId": "CF938302-6B4D-44A0-A6D2-C0D67E847AEC" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptExecutionHistory.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptExecutionHistory.json new file mode 100644 index 000000000000..9014b6ab9941 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/GetScriptExecutionHistory.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "scriptExecutionId": 391145124054712, + "name": "Test", + "applicationName": "app1", + "uri": "http://testurl.com/install.ssh", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [] + }, + { + "scriptExecutionId": 391144597342127, + "name": "Test", + "applicationName": "app2", + "uri": "http://testurl.com/install-script.ssh", + "roles": [ + "headnode", + "workernode" + ], + "startTime": "2017-03-22T21:34:39.293", + "endTime": "2017-03-22T21:34:39.293", + "status": "ValidationFailed", + "operation": "PostClusterCreateScriptActionRequest", + "executionSummary": [] + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_GetGatewaySettings.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_GetGatewaySettings.json new file mode 100644 index 000000000000..7e2c435a42ab --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_GetGatewaySettings.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "hadoop", + "restAuthCredential.password": "**********" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_UpdateClusterIdentityCertificate.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_UpdateClusterIdentityCertificate.json new file mode 100644 index 000000000000..5bdd2c427be0 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_UpdateClusterIdentityCertificate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "applicationId": "applicationId", + "certificate": "base64encodedcertificate", + "certificatePassword": "**********" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "200": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_UpdateGatewaySettings_Enable.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_UpdateGatewaySettings_Enable.json new file mode 100644 index 000000000000..0e99ab593b64 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Clusters_UpdateGatewaySettings_Enable.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "hadoop", + "restAuthCredential.password": "**********" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Configurations_Get.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Configurations_Get.json new file mode 100644 index 000000000000..86dc44101521 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Configurations_Get.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "configurationName": "core-site" + }, + "responses": { + "200": { + "body": { + "fs.defaultFS": "wasb://test.blob.core.windows.net", + "fs.azure.account.key.test.blob.core.windows.net": "accountKey" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Configurations_List.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Configurations_List.json new file mode 100644 index 000000000000..816859132272 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Configurations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "configurations": { + "core-site": { + "fs.defaultFS": "wasb://test.blob.core.windows.net", + "fs.azure.account.key.test.blob.core.windows.net": "accountKey" + }, + "gateway": { + "restAuthCredential.isEnabled": "true", + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_CheckClusterNameAvailability.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_CheckClusterNameAvailability.json new file mode 100644 index 000000000000..14146bcfc4d9 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_CheckClusterNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "name": "test123", + "type": "clusters" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "Cluster name 'test123' is unavailable" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_GetAsyncOperationStatus.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_GetAsyncOperationStatus.json new file mode 100644 index 000000000000..6e3a0206001f --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_GetAsyncOperationStatus.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "location": "East US 2", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "operationId": "8a0348f4-8a85-4ec2-abe0-03b26104a9a0-0" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_ListBillingSpecs.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_ListBillingSpecs.json new file mode 100644 index 000000000000..080c88f53c1c --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_ListBillingSpecs.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "location": "East US 2", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "vmSizes": [ + "A5", + "A6", + "A7" + ], + "vmSizeFilters": [ + { + "filterMode": "Exclude", + "regions": null, + "clusterFlavors": null, + "nodeTypes": null, + "clusterVersions": null, + "osType": null, + "vmSizes": null + } + ], + "billingResources": [ + { + "region": "East US 2", + "billingMeters": [], + "diskBillingMeters": [] + }, + { + "region": "default", + "billingMeters": [ + { + "meterParameter": "default", + "meter": "11111111-1111-1111-1111-111111111111", + "unit": "CoreHours" + }, + { + "meterParameter": "Kafka", + "meter": "11111111-1111-1111-1111-111111111111", + "unit": "CoreHours" + } + ], + "diskBillingMeters": [ + { + "diskRpMeter": "11111111-1111-1111-1111-111111111111", + "sku": "All", + "tier": "Standard" + }, + { + "diskRpMeter": "11111111-1111-1111-1111-111111111111", + "sku": "All", + "tier": "Standard" + } + ] + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_ValidateClusterCreateRequest.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_ValidateClusterCreateRequest.json new file mode 100644 index 000000000000..4c462cd84815 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/HDI_Locations_ValidateClusterCreateRequest.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "location": "southcentralus", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "name": "testclustername", + "type": "Microsoft.HDInsight/clusters", + "location": "southcentralus", + "tags": {}, + "properties": { + "clusterVersion": "4.0", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "spark", + "componentVersion": { + "Spark": "2.4" + }, + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "storagename.blob.core.windows.net", + "isDefault": true, + "container": "contianername", + "key": "*******", + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/storagename", + "enableSecureChannel": true + } + ] + }, + "computeProfile": { + "roles": [ + { + "autoscale": null, + "name": "headnode", + "minInstanceCount": 1, + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_E8_V3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "********" + } + }, + "virtualNetworkProfile": null, + "scriptActions": [], + "dataDisksGroups": null + }, + { + "autoscale": null, + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_E8_V3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "********" + } + }, + "virtualNetworkProfile": null, + "scriptActions": [], + "dataDisksGroups": null + }, + { + "autoscale": null, + "name": "zookeepernode", + "minInstanceCount": 1, + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Standard_D13_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + }, + "virtualNetworkProfile": null, + "scriptActions": [], + "dataDisksGroups": null + } + ] + }, + "minSupportedTlsVersion": "1.2" + }, + "fetchAaddsResource": false, + "tenantId": "00000000-0000-0000-0000-000000000000" + } + }, + "responses": { + "200": { + "body": { + "validationErrors": [], + "estimatedCreationDuration": "PT20M" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ListHDInsightOperations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ListHDInsightOperations.json new file mode 100644 index 000000000000..5b5e5c413f6b --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ListHDInsightOperations.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-04-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.HDInsight/register/action", + "display": { + "provider": "Microsoft.HDInsight", + "resource": null, + "operation": "Register HDInsight resource provider", + "description": "Register HDInsight resource provider for the subscription" + }, + "properties": null + }, + { + "name": "Microsoft.HDInsight/unregister/action", + "display": { + "provider": "Microsoft.HDInsight", + "resource": null, + "operation": "Unregister HDInsight resource provider", + "description": "Unregister HDInsight resource provider for the subscription" + }, + "properties": null + } + ] + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PatchLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PatchLinuxHadoopCluster.json new file mode 100644 index 000000000000..bb526a6ff48b --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PatchLinuxHadoopCluster.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "tags": { + "key1": "val1", + "key2": "val2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "West US", + "etag": "f0212a39-b827-45e0-9ffa-4f5232e58851", + "tags": { + "key1": "val1", + "key2": "val2" + }, + "properties": { + "clusterVersion": "3.5.1000.0", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.5.1000.0.9243893.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 4, + "hardwareProfile": { + "vmSize": "Standard_D3_V2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Medium" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2017-01-11T18:58:26.187", + "quotaInfo": { + "coresUsed": 24 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PostExecuteScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PostExecuteScriptAction.json new file mode 100644 index 000000000000..d40651a93aa7 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PostExecuteScriptAction.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "scriptActions": [ + { + "name": "Test", + "uri": "http://testurl.com/install.ssh", + "roles": [ + "headnode", + "workernode" + ], + "parameters": "" + } + ], + "persistOnSuccess": false + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "200": {}, + "404": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PromoteLinuxHadoopScriptAction.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PromoteLinuxHadoopScriptAction.json new file mode 100644 index 000000000000..772378b06f99 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/PromoteLinuxHadoopScriptAction.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "scriptExecutionId": "391145124054712" + }, + "responses": { + "200": {} + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ResizeLinuxHadoopCluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ResizeLinuxHadoopCluster.json new file mode 100644 index 000000000000..ee82e3900254 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/ResizeLinuxHadoopCluster.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "roleName": "workernode", + "parameters": { + "targetInstanceCount": 10 + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/RestartVirtualMachinesOperation.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/RestartVirtualMachinesOperation.json new file mode 100644 index 000000000000..8b72e0ce5cad --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/RestartVirtualMachinesOperation.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "clusterName": "cluster1", + "hosts": [ + "gateway1", + "gateway3" + ] + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + }, + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json new file mode 100644 index 000000000000..456b82bfe4ab --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/examples/RotateLinuxHadoopClusterDiskEncryptionKey.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2023-04-15-preview", + "subscriptionId": "subid", + "parameters": { + "vaultUri": "https://newkeyvault.vault.azure.net/", + "keyName": "newkeyname", + "keyVersion": "newkeyversion" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1/operationresults/operationid?api-version=2023-04-15-preview" + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/extensions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/extensions.json new file mode 100644 index 000000000000..ad2080622f43 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/extensions.json @@ -0,0 +1,686 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2023-04-15-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/clusters/{clusterName}/extensions/clustermonitoring": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Enables the Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/EnableLinuxClusterMonitoring.json" + } + }, + "operationId": "Extensions_EnableMonitoring", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterMonitoringRequest" + }, + "description": "The Operations Management Suite (OMS) workspace parameters." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Gets the status of Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/GetLinuxClusterMonitoringStatus.json" + } + }, + "operationId": "Extensions_GetMonitoringStatus", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ClusterMonitoringResponse" + } + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Disables the Operations Management Suite (OMS) on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/DisableLinuxClusterMonitoring.json" + } + }, + "operationId": "Extensions_DisableMonitoring", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "OK response definition." + }, + "204": { + "description": "No Content response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/azureMonitor": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Enables the Azure Monitor on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/EnableLinuxClusterAzureMonitor.json" + } + }, + "operationId": "Extensions_EnableAzureMonitor", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureMonitorRequest" + }, + "description": "The Log Analytics workspace parameters." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Gets the status of Azure Monitor on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/GetLinuxClusterAzureMonitorStatus.json" + } + }, + "operationId": "Extensions_GetAzureMonitorStatus", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AzureMonitorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Disables the Azure Monitor on the HDInsight cluster.", + "x-ms-examples": { + "Enable cluster monitoring": { + "$ref": "./examples/DisableLinuxClusterAzureMonitor.json" + } + }, + "operationId": "Extensions_DisableAzureMonitor", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "OK response definition." + }, + "204": { + "description": "No Content response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}": { + "put": { + "tags": [ + "Extensions" + ], + "description": "Creates an HDInsight cluster extension.", + "operationId": "Extensions_Create", + "x-ms-examples": { + "Create a monitoring extension on Hadoop Linux cluster": { + "$ref": "./examples/CreateExtension.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Extension" + }, + "description": "The cluster extensions create request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Extensions" + ], + "description": "Gets the extension properties for the specified HDInsight cluster extension.", + "x-ms-examples": { + "Get an extension": { + "$ref": "./examples/GetExtension.json" + } + }, + "operationId": "Extensions_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ClusterMonitoringResponse" + } + } + } + }, + "delete": { + "tags": [ + "Extensions" + ], + "description": "Deletes the specified extension for HDInsight cluster.", + "x-ms-examples": { + "Delete an extension": { + "$ref": "./examples/DeleteExtension.json" + } + }, + "operationId": "Extensions_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Ok response definition." + }, + "202": { + "description": "Accepted response definition." + }, + "204": { + "description": "No Content response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/extensions/{extensionName}/azureAsyncOperations/{operationId}": { + "get": { + "tags": [ + "Extensions" + ], + "description": "Gets the async operation status.", + "operationId": "Extensions_GetAzureAsyncOperationStatus", + "x-ms-examples": { + "Gets the azure async operation status.": { + "$ref": "./examples/GetExtensionCreationAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ExtensionNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "./cluster.json#/definitions/AsyncOperationResult" + } + } + } + } + } + }, + "definitions": { + "Extension": { + "type": "object", + "description": "Cluster monitoring extensions.", + "properties": { + "workspaceId": { + "description": "The workspace ID for the cluster monitoring extension.", + "type": "string" + }, + "primaryKey": { + "description": "The certificate for the cluster monitoring extensions.", + "type": "string" + } + } + }, + "ClusterMonitoringResponse": { + "type": "object", + "description": "The cluster monitoring status response.", + "properties": { + "clusterMonitoringEnabled": { + "description": "The status of the monitor on the HDInsight cluster.", + "type": "boolean" + }, + "workspaceId": { + "description": "The workspace ID of the monitor on the HDInsight cluster.", + "type": "string" + } + } + }, + "ClusterMonitoringRequest": { + "type": "object", + "description": "The cluster monitor parameters.", + "properties": { + "workspaceId": { + "description": "The cluster monitor workspace ID.", + "type": "string" + }, + "primaryKey": { + "description": "The cluster monitor workspace key.", + "type": "string" + } + } + }, + "AzureMonitorRequest": { + "type": "object", + "description": "The azure monitor parameters.", + "properties": { + "workspaceId": { + "description": "The Log Analytics workspace ID.", + "type": "string" + }, + "primaryKey": { + "description": "The Log Analytics workspace key.", + "type": "string" + }, + "selectedConfigurations": { + "description": "The selected configurations.", + "$ref": "#/definitions/AzureMonitorSelectedConfigurations" + } + } + }, + "AzureMonitorResponse": { + "type": "object", + "description": "The azure monitor status response.", + "properties": { + "clusterMonitoringEnabled": { + "description": "The status of the monitor on the HDInsight cluster.", + "type": "boolean" + }, + "workspaceId": { + "description": "The workspace ID of the monitor on the HDInsight cluster.", + "type": "string" + }, + "selectedConfigurations": { + "description": "The selected configurations.", + "$ref": "#/definitions/AzureMonitorSelectedConfigurations" + } + } + }, + "AzureMonitorSelectedConfigurations": { + "type": "object", + "description": "The selected configurations for azure monitor.", + "properties": { + "configurationVersion": { + "description": "The configuration version.", + "type": "string" + }, + "globalConfigurations": { + "description": "The global configurations of selected configurations.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "tableList": { + "description": "The table list.", + "type": "array", + "items": { + "$ref": "#/definitions/AzureMonitorTableConfiguration" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "AzureMonitorTableConfiguration": { + "type": "object", + "description": "The table configuration for the Log Analytics integration.", + "properties": { + "name": { + "description": "The name.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ExtensionNameParameter": { + "name": "extensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster extension.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The long running operation id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/locations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/locations.json new file mode 100644 index 000000000000..d8582e8baa3d --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/locations.json @@ -0,0 +1,938 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2023-04-15-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}/providers/Microsoft.HDInsight/locations/{location}/capabilities": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_GetCapabilities", + "description": "Gets the capabilities for the specified location.", + "x-ms-examples": { + "Get the subscription capabilities for specific location": { + "$ref": "./examples/GetHDInsightCapabilities.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/CapabilitiesResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/usages": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_ListUsages", + "description": "Lists the usages for the specified location.", + "x-ms-examples": { + "Get the subscription usages for specific location": { + "$ref": "./examples/GetHDInsightUsages.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/billingSpecs": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_ListBillingSpecs", + "description": "Lists the billingSpecs for the specified subscription and location.", + "x-ms-examples": { + "Get the subscription billingSpecs for the specified location": { + "$ref": "./examples/HDI_Locations_ListBillingSpecs.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/BillingResponseListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/azureasyncoperations/{operationId}": { + "get": { + "tags": [ + "Regions" + ], + "operationId": "Locations_GetAzureAsyncOperationStatus", + "description": "Get the async operation status.", + "x-ms-examples": { + "Gets the azure async operation status.": { + "$ref": "./examples/HDI_Locations_GetAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "./cluster.json#/definitions/AsyncOperationResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "Regions" + ], + "operationId": "Locations_CheckNameAvailability", + "description": "Check the cluster name is available or not.", + "x-ms-examples": { + "Get the subscription usages for specific location": { + "$ref": "./examples/HDI_Locations_CheckClusterNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NameAvailabilityCheckRequestParameters" + } + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/NameAvailabilityCheckResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.HDInsight/locations/{location}/validateCreateRequest": { + "post": { + "tags": [ + "Regions" + ], + "operationId": "Locations_ValidateClusterCreateRequest", + "description": "Validate the cluster create request spec is valid or not.", + "x-ms-examples": { + "Get the subscription usages for specific location": { + "$ref": "./examples/HDI_Locations_ValidateClusterCreateRequest.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterCreateRequestValidationParameters" + } + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ClusterCreateValidationResult" + } + } + } + } + } + }, + "definitions": { + "VersionSpec": { + "type": "object", + "description": "The version properties.", + "properties": { + "friendlyName": { + "type": "string", + "description": "The friendly name" + }, + "displayName": { + "type": "string", + "description": "The display name" + }, + "isDefault": { + "type": "boolean", + "description": "Whether or not the version is the default version." + }, + "componentVersions": { + "type": "object", + "description": "The component version property.", + "additionalProperties": { + "type": "string" + } + } + }, + "readOnly": true + }, + "VersionsCapability": { + "type": "object", + "description": "The version capability.", + "properties": { + "available": { + "description": "The list of version capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/VersionSpec" + }, + "x-ms-identifiers": [ + "friendlyName" + ] + } + }, + "readOnly": true + }, + "RegionsCapability": { + "type": "object", + "description": "The regions capability.", + "properties": { + "available": { + "description": "The list of region capabilities.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "readOnly": true + }, + "RegionalQuotaCapability": { + "type": "object", + "description": "The regional quota capacity.", + "properties": { + "regionName": { + "description": "The region name.", + "type": "string" + }, + "coresUsed": { + "description": "The number of cores used in the region.", + "type": "integer", + "format": "int64" + }, + "coresAvailable": { + "description": "The number of cores available in the region.", + "type": "integer", + "format": "int64" + } + }, + "readOnly": true + }, + "QuotaCapability": { + "type": "object", + "description": "The regional quota capability.", + "properties": { + "coresUsed": { + "description": "The number of cores used in the subscription.", + "type": "integer", + "format": "int64" + }, + "maxCoresAllowed": { + "description": "The number of cores that the subscription allowed.", + "type": "integer", + "format": "int64" + }, + "regionalQuotas": { + "description": "The list of region quota capabilities.", + "type": "array", + "items": { + "$ref": "#/definitions/RegionalQuotaCapability" + }, + "x-ms-identifiers": [ + "regionName" + ] + } + }, + "readOnly": true + }, + "CapabilitiesResult": { + "type": "object", + "description": "The Get Capabilities operation response.", + "properties": { + "versions": { + "description": "The version capability.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/VersionsCapability" + } + }, + "regions": { + "description": "The virtual machine size compatibility features.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/RegionsCapability" + } + }, + "features": { + "description": "The capability features.", + "type": "array", + "items": { + "type": "string" + } + }, + "quota": { + "description": "The quota capability.", + "$ref": "#/definitions/QuotaCapability" + } + }, + "readOnly": true + }, + "LocalizedName": { + "type": "object", + "description": "The details about the localizable name of a type of usage.", + "properties": { + "value": { + "description": "The name of the used resource.", + "type": "string" + }, + "localizedValue": { + "description": "The localized name of the used resource.", + "type": "string" + } + }, + "readOnly": true + }, + "Usage": { + "type": "object", + "description": "The details about the usage of a particular limited resource.", + "properties": { + "unit": { + "description": "The type of measurement for usage.", + "type": "string" + }, + "currentValue": { + "description": "The current usage.", + "type": "integer", + "format": "int64" + }, + "limit": { + "description": "The maximum allowed usage.", + "type": "integer", + "format": "int64" + }, + "name": { + "description": "The details about the localizable name of the used resource.", + "$ref": "#/definitions/LocalizedName" + } + }, + "readOnly": true + }, + "UsagesListResult": { + "type": "object", + "description": "The response for the operation to get regional usages for a subscription.", + "properties": { + "value": { + "description": "The list of usages.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [] + } + }, + "readOnly": true + }, + "BillingResponseListResult": { + "type": "object", + "description": "The response for the operation to get regional billingSpecs for a subscription.", + "properties": { + "vmSizes": { + "description": "The virtual machine sizes to include or exclude.", + "type": "array", + "items": { + "type": "string" + } + }, + "vmSizesWithEncryptionAtHost": { + "description": "The vm sizes which enable encryption at host.", + "type": "array", + "items": { + "type": "string" + } + }, + "vmSizeFilters": { + "description": "The virtual machine filtering mode. Effectively this can enabling or disabling the virtual machine sizes in a particular set.", + "type": "array", + "items": { + "$ref": "#/definitions/VmSizeCompatibilityFilterV2" + }, + "x-ms-identifiers": [] + }, + "vmSizeProperties": { + "description": "The vm size properties.", + "type": "array", + "items": { + "$ref": "#/definitions/VmSizeProperty" + }, + "x-ms-identifiers": [ + "name" + ], + "readOnly": true + }, + "billingResources": { + "description": "The billing and managed disk billing resources for a region.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingResources" + }, + "x-ms-identifiers": [] + } + } + }, + "VmSizeProperty": { + "type": "object", + "description": "The vm size property", + "properties": { + "name": { + "description": "The vm size name.", + "type": "string" + }, + "cores": { + "description": "The number of cores that the vm size has.", + "type": "integer", + "format": "int32" + }, + "dataDiskStorageTier": { + "description": "The data disk storage tier of the vm size.", + "type": "string" + }, + "label": { + "description": "The label of the vm size.", + "type": "string" + }, + "maxDataDiskCount": { + "description": "The max data disk count of the vm size.", + "type": "integer", + "format": "int64" + }, + "memoryInMb": { + "description": "The memory whose unit is MB of the vm size.", + "type": "integer", + "format": "int64" + }, + "supportedByVirtualMachines": { + "description": "This indicates this vm size is supported by virtual machines or not", + "type": "boolean" + }, + "supportedByWebWorkerRoles": { + "description": "The indicates this vm size is supported by web worker roles or not", + "type": "boolean" + }, + "virtualMachineResourceDiskSizeInMb": { + "description": "The virtual machine resource disk size whose unit is MB of the vm size.", + "type": "integer", + "format": "int64" + }, + "webWorkerResourceDiskSizeInMb": { + "description": "The web worker resource disk size whose unit is MB of the vm size.", + "type": "integer", + "format": "int64" + } + } + }, + "VmSizeCompatibilityFilterV2": { + "type": "object", + "description": "This class represent a single filter object that defines a multidimensional set. The dimensions of this set are Regions, ClusterFlavors, NodeTypes and ClusterVersions. The constraint should be defined based on the following: FilterMode (Exclude vs Include), VMSizes (the vm sizes in affect of exclusion/inclusion) and the ordering of the Filters. Later filters override previous settings if conflicted.", + "properties": { + "filterMode": { + "description": "The filtering mode. Effectively this can enabling or disabling the VM sizes in a particular set.", + "type": "string", + "enum": [ + "Exclude", + "Include", + "Recommend", + "Default" + ], + "x-ms-enum": { + "name": "FilterMode", + "modelAsString": true + } + }, + "regions": { + "description": "The list of regions under the effect of the filter.", + "type": "array", + "items": { + "type": "string" + } + }, + "clusterFlavors": { + "description": "The list of cluster flavors under the effect of the filter.", + "type": "array", + "items": { + "type": "string" + } + }, + "nodeTypes": { + "description": "The list of node types affected by the filter.", + "type": "array", + "items": { + "type": "string" + } + }, + "clusterVersions": { + "description": "The list of cluster versions affected in Major.Minor format.", + "type": "array", + "items": { + "type": "string" + } + }, + "osType": { + "description": "The OSType affected, Windows or Linux.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true + } + } + }, + "vmSizes": { + "description": "The list of virtual machine sizes to include or exclude.", + "type": "array", + "items": { + "type": "string" + } + }, + "espApplied": { + "description": "Whether apply for ESP cluster. 'true' means only for ESP, 'false' means only for non-ESP, null or empty string or others mean for both.", + "type": "string" + }, + "computeIsolationSupported": { + "description": "Whether support compute isolation. 'true' means only for ComputeIsolationEnabled, 'false' means only for regular cluster.", + "type": "string" + } + } + }, + "BillingResources": { + "type": "object", + "description": "The billing resources.", + "properties": { + "region": { + "description": "The region or location.", + "type": "string" + }, + "billingMeters": { + "description": "The billing meter information.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingMeters" + }, + "x-ms-identifiers": [ + "meter" + ] + }, + "diskBillingMeters": { + "description": "The managed disk billing information.", + "type": "array", + "items": { + "$ref": "#/definitions/DiskBillingMeters" + }, + "x-ms-identifiers": [ + "diskRpMeter" + ] + } + } + }, + "BillingMeters": { + "type": "object", + "description": "The billing meters.", + "properties": { + "meterParameter": { + "description": "The virtual machine sizes.", + "type": "string" + }, + "meter": { + "description": "The HDInsight meter guid.", + "type": "string" + }, + "unit": { + "description": "The unit of meter, VMHours or CoreHours.", + "type": "string" + } + } + }, + "DiskBillingMeters": { + "type": "object", + "description": "The disk billing meters.", + "properties": { + "diskRpMeter": { + "description": "The managed disk meter guid.", + "type": "string" + }, + "sku": { + "description": "The managed disk billing sku, P30 or S30.", + "type": "string" + }, + "tier": { + "description": "The managed disk billing tier, Standard or Premium.", + "type": "string", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "Tier", + "modelAsString": true + } + } + } + }, + "NameAvailabilityCheckRequestParameters": { + "type": "object", + "description": "The request spec of checking name availability.", + "properties": { + "name": { + "description": "The resource name.", + "type": "string" + }, + "type": { + "description": "The resource type", + "type": "string" + } + } + }, + "NameAvailabilityCheckResult": { + "type": "object", + "description": "The response spec of checking name availability.", + "properties": { + "nameAvailable": { + "description": "This indicates whether the name is available.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the result.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The related message.", + "type": "string", + "readOnly": true + } + } + }, + "ClusterCreateRequestValidationParameters": { + "type": "object", + "description": "The cluster create request specification.", + "allOf": [ + { + "$ref": "./cluster.json#/definitions/ClusterCreateParametersExtended" + } + ], + "properties": { + "name": { + "description": "The cluster name.", + "type": "string" + }, + "type": { + "description": "The resource type.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id.", + "type": "string" + }, + "fetchAaddsResource": { + "description": "This indicates whether fetch Aadds resource or not.", + "type": "boolean" + } + } + }, + "ClusterCreateValidationResult": { + "type": "object", + "description": "The response of cluster create request validation.", + "properties": { + "validationErrors": { + "description": "The validation errors.", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationErrorInfo" + }, + "x-ms-identifiers": [ + "code" + ] + }, + "validationWarnings": { + "description": "The validation warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/ValidationErrorInfo" + }, + "x-ms-identifiers": [ + "code" + ] + }, + "estimatedCreationDuration": { + "description": "The estimated creation duration.", + "type": "string", + "format": "duration" + }, + "aaddsResourcesDetails": { + "description": "The Azure active directory domain service resource details.", + "type": "array", + "items": { + "$ref": "#/definitions/AaddsResourceDetails" + }, + "x-ms-identifiers": [ + "resourceId" + ] + } + } + }, + "ValidationErrorInfo": { + "type": "object", + "description": "The validation error information.", + "properties": { + "code": { + "description": "The error code.", + "type": "string" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "errorResource": { + "description": "The error resource.", + "type": "string" + }, + "messageArguments": { + "description": "The message arguments", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AaddsResourceDetails": { + "type": "object", + "description": "The Azure active directory domain service resource details.", + "properties": { + "domainName": { + "description": "The Azure active directory domain service name.", + "type": "string" + }, + "initialSyncComplete": { + "description": "This indicates whether initial sync complete or not.", + "type": "boolean" + }, + "ldapsEnabled": { + "description": "This indicates whether enable ldaps or not.", + "type": "boolean" + }, + "ldapsPublicCertificateInBase64": { + "description": "The base 64 format string of public ldap certificate.", + "type": "string" + }, + "resourceId": { + "description": "The resource id of azure active directory domain service.", + "type": "string" + }, + "subnetId": { + "description": "The subnet resource id.", + "type": "string" + }, + "tenantId": { + "description": "The tenant id of azure active directory domain service .", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure location (region) for which to make the request.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The long running operation id.", + "x-ms-parameter-location": "method" + }, + "ValidationLevelParameter": { + "name": "validation-level", + "in": "query", + "required": true, + "type": "integer", + "format": "int32", + "default": -1, + "description": "The validation level.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/operations.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/operations.json new file mode 100644 index 000000000000..9f099433e2a2 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/operations.json @@ -0,0 +1,295 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2023-04-15-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.HDInsight/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available HDInsight REST API operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Lists all of the available operations": { + "$ref": "./examples/ListHDInsightOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Operation": { + "description": "The HDInsight REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "The operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The display of operation.", + "$ref": "#/definitions/OperationDisplay" + }, + "properties": { + "description": "The operation properties.", + "$ref": "#/definitions/OperationProperties" + } + }, + "readOnly": true + }, + "OperationDisplay": { + "type": "object", + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "The service provider: Microsoft.HDInsight", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed: Cluster, Applications, etc.", + "type": "string" + }, + "operation": { + "description": "The operation type: read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "The details of operation.", + "type": "object", + "properties": { + "serviceSpecification": { + "description": "The specification of the service.", + "$ref": "#/definitions/ServiceSpecification" + } + } + }, + "ServiceSpecification": { + "description": "The specification of the service.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "The metric specifications.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecifications" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "MetricSpecifications": { + "description": "The details of metric specifications.", + "type": "object", + "properties": { + "name": { + "description": "The name of the metric specification.", + "type": "string" + }, + "displayName": { + "description": "The display name of the metric specification.", + "type": "string" + }, + "displayDescription": { + "description": "The display description of the metric specification.", + "type": "string" + }, + "unit": { + "description": "The unit of the metric specification.", + "type": "string" + }, + "aggregationType": { + "description": "The aggregation type of the metric specification.", + "type": "string" + }, + "supportedAggregationTypes": { + "description": "The supported aggregation types of the metric specification.", + "type": "array", + "items": { + "type": "string" + } + }, + "supportedTimeGrainTypes": { + "description": "The supported time grain types of the metric specification.", + "type": "array", + "items": { + "type": "string" + } + }, + "enableRegionalMdmAccount": { + "description": "The flag indicates whether enable regional mdm account or not.", + "type": "boolean" + }, + "sourceMdmAccount": { + "description": "The source mdm account.", + "type": "string" + }, + "sourceMdmNamespace": { + "description": "The source mdm namespace.", + "type": "string" + }, + "metricFilterPattern": { + "description": "The metric filter pattern.", + "type": "string" + }, + "fillGapWithZero": { + "description": "The flag indicates whether filling gap with zero.", + "type": "boolean" + }, + "category": { + "description": "The category of the metric.", + "type": "string" + }, + "resourceIdDimensionNameOverride": { + "description": "The override name of resource id dimension name.", + "type": "string" + }, + "isInternal": { + "description": "The flag indicates whether the metric is internal or not.", + "type": "boolean" + }, + "delegateMetricNameOverride": { + "description": "The override name of delegate metric.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metric specification.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Dimension": { + "description": "The definition of Dimension.", + "type": "object", + "properties": { + "name": { + "description": "The name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "The display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "The display name of the dimension.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "The flag indicates whether the metric will be exported for shoebox or not.", + "type": "boolean" + } + } + }, + "OperationListResult": { + "type": "object", + "description": "Result of the request to list HDInsight 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" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "The list of HDInsight operations supported by the HDInsight resource provider." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of operation list results if there are any." + } + }, + "readOnly": true + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/privateEndpointConnections.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/privateEndpointConnections.json new file mode 100644 index 000000000000..16792d71b6c2 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/privateEndpointConnections.json @@ -0,0 +1,404 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2023-04-15-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/clusters/{clusterName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_ListByCluster", + "description": "Lists the private endpoint connections for a HDInsight cluster.", + "x-ms-examples": { + "Get all private endpoint connections for a specific HDInsight cluster.": { + "$ref": "./examples/GetAllPrivateEndpointConnectionsInCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "description": "Approve or reject a private endpoint connection manually.", + "x-ms-examples": { + "Approve a private endpoint connection manually.": { + "$ref": "./examples/ApprovePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection create or update request." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created response definition", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specific private endpoint connection.", + "x-ms-examples": { + "Get specific private endpoint connection for a specific HDInsight cluster.": { + "$ref": "./examples/GetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specific private endpoint connection.", + "x-ms-examples": { + "Delete specific private endpoint connection for a specific HDInsight cluster.": { + "$ref": "./examples/DeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "Accepted response definition." + }, + "200": { + "description": "Ok response definition." + }, + "204": { + "description": "No Content response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "The list private endpoint connections response.", + "properties": { + "value": { + "type": "array", + "description": "The list of private endpoint connections.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "description": "The private endpoint connection.", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The private endpoint connection properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./cluster.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "The private endpoint connection properties.", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The private endpoint of the private endpoint connection", + "readOnly": true + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "The private link service connection state." + }, + "linkIdentifier": { + "type": "string", + "description": "The link identifier.", + "readOnly": true + }, + "provisioningState": { + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "enum": [ + "InProgress", + "Updating", + "Failed", + "Succeeded", + "Canceled", + "Deleting" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "The private endpoint.", + "properties": { + "id": { + "type": "string", + "description": "The private endpoint id." + } + } + }, + "PrivateLinkServiceConnectionState": { + "type": "object", + "description": "The private link service connection state.", + "properties": { + "status": { + "type": "string", + "description": "The concrete private link service connection.", + "enum": [ + "Approved", + "Rejected", + "Pending", + "Removed" + ], + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The optional description of the status." + }, + "actionsRequired": { + "type": "string", + "description": "Whether there is further actions." + } + }, + "required": [ + "status" + ] + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + }, + "PrivateEndpointConnectionNameParameter": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/privateLinkResources.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/privateLinkResources.json new file mode 100644 index 000000000000..cb8e1de9238e --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/privateLinkResources.json @@ -0,0 +1,200 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2023-04-15-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/clusters/{clusterName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByCluster", + "description": "Lists the private link resources in a HDInsight cluster.", + "x-ms-examples": { + "Get all private link resources in a specific HDInsight cluster.": { + "$ref": "./examples/GetAllPrivateLinkResourcesInCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "description": "Gets the specific private link resource.", + "x-ms-examples": { + "Get specific private link resource in a specific HDInsight cluster.": { + "$ref": "./examples/GetPrivateLinkResource.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PrivateLinkResourceNameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + } + } + } + }, + "definitions": { + "PrivateLinkResource": { + "type": "object", + "properties": { + "properties": { + "$ref": "../../../../../common-types/resource-management/v2/privatelinks.json#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + }, + "PrivateLinkResourceNameParameter": { + "name": "privateLinkResourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/scriptActions.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/scriptActions.json new file mode 100644 index 000000000000..106dbc0d2433 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/scriptActions.json @@ -0,0 +1,513 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2023-04-15-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/clusters/{clusterName}/scriptActions/{scriptName}": { + "delete": { + "tags": [ + "ScriptActions" + ], + "operationId": "ScriptActions_Delete", + "description": "Deletes a specified persisted script action of the cluster.", + "x-ms-examples": { + "Delete a script action on HDInsight cluster": { + "$ref": "./examples/DeleteScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "204": { + "description": "No Content response definition." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ExecuteScriptActions", + "description": "Executes script actions on the specified HDInsight cluster.", + "x-ms-examples": { + "Execute script action on HDInsight cluster": { + "$ref": "./examples/PostExecuteScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./cluster.json#/definitions/ExecuteScriptActionParameters" + }, + "description": "The parameters for executing script actions." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "202": { + "description": "OK response definition." + }, + "200": { + "description": "Accepted response definition." + }, + "404": { + "description": "Bad Request definition.", + "x-ms-error-response": true + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptActions": { + "get": { + "tags": [ + "ScriptActions" + ], + "operationId": "ScriptActions_ListByCluster", + "description": "Lists all the persisted script actions for the specified cluster.", + "x-ms-examples": { + "List all persisted script actions for the given cluster": { + "$ref": "./examples/GetLinuxHadoopScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ScriptActionsList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}": { + "get": { + "tags": [ + "ScriptExecutionHistory" + ], + "operationId": "ScriptActions_GetExecutionDetail", + "description": "Gets the script execution detail for the given script execution ID.", + "x-ms-examples": { + "Get script execution history by script id": { + "$ref": "./examples/GetScriptActionById.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptExecutionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory": { + "get": { + "tags": [ + "ScriptExecutionHistory" + ], + "operationId": "ScriptExecutionHistory_ListByCluster", + "description": "Lists all scripts' execution history for the specified cluster.", + "x-ms-examples": { + "Get Script Execution History List": { + "$ref": "./examples/GetScriptExecutionHistory.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/ScriptActionExecutionHistoryList" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/scriptExecutionHistory/{scriptExecutionId}/promote": { + "post": { + "tags": [ + "Promote" + ], + "operationId": "ScriptExecutionHistory_Promote", + "description": "Promotes the specified ad-hoc script execution to a persisted script.", + "x-ms-examples": { + "Promote a script action on HDInsight cluster": { + "$ref": "./examples/PromoteLinuxHadoopScriptAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ScriptExecutionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/executeScriptActions/azureasyncoperations/{operationId}": { + "get": { + "tags": [ + "ScriptActions" + ], + "operationId": "ScriptActions_GetExecutionAsyncOperationStatus", + "description": "Gets the async operation status of execution operation.", + "x-ms-examples": { + "Gets the async execution operation status.": { + "$ref": "./examples/GetScriptExecutionAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "./cluster.json#/definitions/AsyncOperationResult" + } + } + } + } + } + }, + "definitions": { + "ScriptActionExecutionHistoryList": { + "type": "object", + "description": "The list script execution history response.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + }, + "x-ms-identifiers": [], + "description": "The list of persisted script action details for the cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + }, + "ScriptAction": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script provided." + } + }, + "required": [ + "name", + "uri", + "parameters" + ], + "description": "Describes a script action on role on the cluster." + }, + "ScriptActionPersistedGetResponseSpec": { + "type": "object", + "description": "The persisted script action for cluster.", + "properties": { + "name": { + "type": "string", + "description": "The name of script action." + }, + "uri": { + "type": "string", + "description": "The URI to the script." + }, + "parameters": { + "type": "string", + "description": "The parameters for the script provided." + }, + "roles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of roles where script will be executed." + }, + "applicationName": { + "type": "string", + "description": "The application name for the script action." + } + } + }, + "ScriptActionsList": { + "type": "object", + "description": "The persisted script action for the cluster.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./cluster.json#/definitions/RuntimeScriptActionDetail" + }, + "x-ms-identifiers": [], + "description": "The list of persisted script action details for the cluster." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The link (url) to the next page of results." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ScriptNameParameter": { + "name": "scriptName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the script.", + "x-ms-parameter-location": "method" + }, + "ScriptExecutionIdParameter": { + "name": "scriptExecutionId", + "in": "path", + "required": true, + "type": "string", + "description": "The script execution Id", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The long running operation id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/virtualMachines.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/virtualMachines.json new file mode 100644 index 000000000000..e5fc4d975604 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2023-04-15-preview/virtualMachines.json @@ -0,0 +1,273 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightManagementClient", + "description": "The HDInsight Management Client.", + "version": "2023-04-15-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/clusters/{clusterName}/listHosts": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListHosts", + "description": "Lists the HDInsight clusters hosts", + "x-ms-examples": { + "Get All hosts in the cluster": { + "$ref": "./examples/GetClusterVirtualMachines.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "#/definitions/HostInfoListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_RestartHosts", + "description": "Restarts the specified HDInsight cluster hosts.", + "x-ms-examples": { + "Restarts the specified HDInsight cluster hosts.": { + "$ref": "./examples/RestartVirtualMachinesOperation.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "hosts", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RestartHostsParameters" + }, + "description": "The list of hosts to restart" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition." + }, + "202": { + "description": "Accepted response definition." + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HDInsight/clusters/{clusterName}/restartHosts/azureasyncoperations/{operationId}": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_GetAsyncOperationStatus", + "description": "Gets the async operation status.", + "x-ms-examples": { + "Gets the async operation status of restarting host.": { + "$ref": "./examples/GetRestartHostsAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./operations.json#/definitions/ErrorResponse" + } + }, + "200": { + "description": "OK response definition.", + "schema": { + "$ref": "./cluster.json#/definitions/AsyncOperationResult" + } + } + } + } + } + }, + "definitions": { + "HostInfo": { + "type": "object", + "description": "The cluster host information.", + "properties": { + "name": { + "description": "The host name", + "type": "string" + }, + "fqdn": { + "description": "The Fully Qualified Domain Name of host", + "type": "string" + }, + "effectiveDiskEncryptionKeyUrl": { + "description": "The effective disk encryption key URL used by the host", + "type": "string" + } + }, + "readOnly": true + }, + "HostInfoListResult": { + "description": "Result of the request to list cluster hosts", + "type": "array", + "items": { + "$ref": "#/definitions/HostInfo" + }, + "x-ms-identifiers": [ + "fqdn" + ], + "readOnly": true + }, + "RestartHostsParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of hosts which need to be restarted." + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cluster.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The HDInsight client API Version." + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The long running operation id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/hdinsight/resource-manager/readme.md b/specification/hdinsight/resource-manager/readme.md index bbc477506a2e..a63de81d02fb 100644 --- a/specification/hdinsight/resource-manager/readme.md +++ b/specification/hdinsight/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for HDInsight. - - --- + ## Getting Started + To build the SDK for HDInsight, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,13 +15,13 @@ To build the SDK for HDInsight, simply [Install AutoRest](https://aka.ms/autores To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the HDInsight API. ``` yaml @@ -29,10 +29,11 @@ title: HDInsightManagementClient description: HDInsight Management Client openapi-type: arm azure-arm: true -tag: package-2021-06 +tag: package-preview-2023-04 ``` ### Suppression + ``` yaml directive: - suppress: DefinitionsPropertiesNamesCamelCase @@ -55,7 +56,7 @@ directive: - $.definitions.VmSizeCompatibilityFilter.properties.ESPApplied - $.definitions.VmSizeCompatibilityFilter.properties.ComputeIsolationSupported ``` - + ``` yaml directive: - suppress: DefinitionsPropertiesNamesCamelCase @@ -108,6 +109,24 @@ directive: reason: Update the default error response to a new format would be a braking change for service. ``` + +### Tag: package-preview-2023-04 + +These settings apply only when `--tag=package-preview-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-04' +input-file: + - Microsoft.HDInsight/preview/2023-04-15-preview/applications.json + - Microsoft.HDInsight/preview/2023-04-15-preview/cluster.json + - Microsoft.HDInsight/preview/2023-04-15-preview/configurations.json + - Microsoft.HDInsight/preview/2023-04-15-preview/extensions.json + - Microsoft.HDInsight/preview/2023-04-15-preview/locations.json + - Microsoft.HDInsight/preview/2023-04-15-preview/operations.json + - Microsoft.HDInsight/preview/2023-04-15-preview/privateEndpointConnections.json + - Microsoft.HDInsight/preview/2023-04-15-preview/privateLinkResources.json + - Microsoft.HDInsight/preview/2023-04-15-preview/scriptActions.json + - Microsoft.HDInsight/preview/2023-04-15-preview/virtualMachines.json +``` ### Tag: package-2021-06 These settings apply only when `--tag=package-2021-06` is specified on the command line. @@ -126,7 +145,6 @@ input-file: - Microsoft.HDInsight/stable/2021-06-01/privateLinkResources.json ``` - ### Tag: package-2018-06-preview These settings apply only when `--tag=package-2018-06-preview` is specified on the command line. @@ -143,7 +161,6 @@ input-file: - Microsoft.HDInsight/stable/2018-06-01-preview/virtualMachines.json ``` - ### Tag: package-2015-03-preview These settings apply only when `--tag=package-2015-03-preview` is specified on the command line. @@ -160,10 +177,9 @@ input-file: - Microsoft.HDInsight/preview/2015-03-01-preview/virtualMachines.json ``` - --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -203,7 +219,6 @@ csharp: clear-output-folder: true ``` - ## Java These settings apply only when `--java` is specified on the command line. @@ -226,7 +241,6 @@ batch: - tag: package-2015-03-preview ``` - ### Tag: package-2018-06-preview and java These settings apply only when `--tag=package-2015-03-preview --java` is specified on the command line. @@ -240,7 +254,6 @@ regenerate-manager: true generate-interface: true ``` - ### Tag: package-2015-03-preview and java These settings apply only when `--tag=package-2015-03-preview --java` is specified on the command line. @@ -253,8 +266,3 @@ java: regenerate-manager: true generate-interface: true ``` - - - - - From 41eb12296f483d6b5acf9c58e9bd130075b00624 Mon Sep 17 00:00:00 2001 From: zhenbiao wei <424401670@qq.com> Date: Thu, 4 May 2023 10:47:26 +0800 Subject: [PATCH 10/79] Update readme.python.md (#23809) * Update readme.python.md * Update readme.python.md --- .../resource-manager/readme.python.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/specification/resourcehealth/resource-manager/readme.python.md b/specification/resourcehealth/resource-manager/readme.python.md index 84a0ccc78f1a..0f7a769cb37c 100644 --- a/specification/resourcehealth/resource-manager/readme.python.md +++ b/specification/resourcehealth/resource-manager/readme.python.md @@ -16,9 +16,10 @@ Generate all API versions currently shipped for this package ```yaml $(python) multiapi: true -default-api-version: "2018-07-01" +default-api-version: "2022-10-01" clear-output-folder: true batch: + - tag: package-2022-10 - tag: package-2018-07-01 - tag: package-2015-01 - multiapiscript: true @@ -29,6 +30,16 @@ output-folder: $(python-sdks-folder)/resourcehealth/azure-mgmt-resourcehealth/az perform-load: false ``` +### Tag: package-2022-10 and python + +These settings apply only when `--tag=package-2022-10 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2022-10' +namespace: azure.mgmt.resourcehealth.v2022_10_01 +output-folder: $(python-sdks-folder)/resourcehealth/azure-mgmt-resourcehealth/azure/mgmt/resourcehealth/v2022_10_01 +``` + ### Tag: package-2018-07-01 and python These settings apply only when `--tag=package-2018-07-01 --python` is specified on the command line. From 9f82fe50e3622d2b45f619749e769a98fe504f1b Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Thu, 4 May 2023 11:44:04 +0800 Subject: [PATCH 11/79] Update pr assignment config (#23808) --- .github/pull_request_assignment.yml | 105 ++++++++++++++-------------- 1 file changed, 52 insertions(+), 53 deletions(-) diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index 11a4bfc62ce5..1111b746d2db 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -74,18 +74,13 @@ - "specification/**/*Management.Shared/**/*.tsp" - "specification/**/resource-manager/**/*.tsp" reviewers: - - raych1 - - lirenhe - - weidongxu-microsoft - - ArcturusZhang - - chunyu3 - - msyyc - - live1206 - - tadelesh - - haolingdong-msft - - XiaofeiCao - - MaryGao - - qiaozha + - JackTn + - keryul + - zedy-wj + - v-jiaodi + - Wzb123456789 + - kazrael2119 + - v-xuto - rule: paths: @@ -101,107 +96,115 @@ paths: - "specification/network/**" reviewers: - - lirenhe - - raych1 + - JackTn + - keryul branches: - - network- + - release-network-Microsoft.Network-official - rule: paths: "specification/common-types/**" reviewers: - - raych1 - - weidongxu-microsoft - - lirenhe - - -- rule: - paths: "specification/providerhub/**" - reviewers: - - raych1 + - v-xuto + - weshaggard + - rule: paths: "specification/sql/**" reviewers: - - raych1 + - v-xuto branches: - dev-sql- - rule: paths: "specification/@(financialdataservices|standbypool)/**" reviewers: - - live1206 + - JackTn + - keryul branches: - RPSaaSDev - rule: paths: "specification/compute/**" reviewers: - - ArcturusZhang + - JackTn + - keryul - rule: paths: - "specification/machinelearningservices/**" reviewers: - - ArcturusZhang + - zedy-wj + - v-jiaodi - rule: paths: - "specification/monitor/**" reviewers: - - ArcturusZhang + - zedy-wj + - v-jiaodi - rule: paths: - "specification/@(azurestackhci|security)/**" reviewers: - - chunyu3 + - Wzb123456789 + - kazrael2119 - rule: paths: - "specification/@(web|app)/**" reviewers: - - weidongxu-microsoft + - Wzb123456789 + - kazrael2119 - rule: paths: "specification/@(synapse|azurearcdata)/**" reviewers: - - msyyc + - zedy-wj + - v-jiaodi - rule: paths: "specification/@(workloads|apimanagement)/**" reviewers: - - live1206 + - zedy-wj + - v-jiaodi - rule: paths: "specification/@(securityinsights|impact)/**" reviewers: - - tadelesh + - JackTn + - keryul - rule: paths: "specification/@(appcomplianceautomation|hybridnetwork)/**" reviewers: - - haolingdong-msft + - zedy-wj + - v-jiaodi -#- rule: - # paths: "specification/@(cost-management|hybridconnectivity)/**" - # reviewers: - # - archerzz +- rule: + paths: "specification/@(cost-management|hybridconnectivity)/**" + reviewers: + - JackTn + - keryul - rule: paths: "specification/@(billing|resources)/**" reviewers: - - XiaofeiCao + - Wzb123456789 + - kazrael2119 - rule: paths: "specification/@(testbase|appplatform)/**" reviewers: - - MaryGao + - JackTn + - keryul - rule: paths: "specification/@(containerservice|paloaltonetworks)/**" reviewers: - - qiaozha + - zedy-wj + - v-jiaodi - rule: paths: @@ -226,14 +229,10 @@ paths: - "**" reviewers: - - lirenhe - - weidongxu-microsoft - - ArcturusZhang - - chunyu3 - - msyyc - - live1206 - - tadelesh - - haolingdong-msft - - XiaofeiCao - - MaryGao - - qiaozha + - JackTn + - keryul + - zedy-wj + - v-jiaodi + - Wzb123456789 + - kazrael2119 + - v-xuto From 32e5ec18ee2125c2638de8d48d63053fa5e4af93 Mon Sep 17 00:00:00 2001 From: Jimmy Campbell Date: Wed, 3 May 2023 21:13:49 -0700 Subject: [PATCH 12/79] Update App Configuration management plane API description (#23778) * Update description to declare intent behind key-value management plane API. * Update wording. --- .../stable/2023-03-01/appconfiguration.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json index c4cab0a285bb..ae5c9edcd871 100644 --- a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2023-03-01/appconfiguration.json @@ -821,7 +821,7 @@ "tags": [ "KeyValues" ], - "description": "Gets the properties of the specified key-value.", + "description": "Gets the properties of the specified key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.", "operationId": "KeyValues_Get", "parameters": [ { @@ -868,7 +868,7 @@ "tags": [ "KeyValues" ], - "description": "Creates a key-value.", + "description": "Creates a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.", "operationId": "KeyValues_CreateOrUpdate", "parameters": [ { @@ -924,7 +924,7 @@ "tags": [ "KeyValues" ], - "description": "Deletes a key-value.", + "description": "Deletes a key-value. NOTE: This operation is intended for use in ARM Template deployments. For all other scenarios involving App Configuration key-values the data plane API should be used instead.", "operationId": "KeyValues_Delete", "parameters": [ { From d838cd16762ded173b75dfb43e755530b4ed4043 Mon Sep 17 00:00:00 2001 From: prchalla1 <111384538+prchalla1@users.noreply.github.com> Date: Wed, 3 May 2023 22:17:26 -0700 Subject: [PATCH 13/79] Reverting the ErrorCode to String (#23790) --- .../stable/2022-10-01/common-types.json | 3 +-- ...teDetailedCostReportOperationStatusBySubscriptionScope.json | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/common-types.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/common-types.json index 3b89e5c1ca5c..a4c90404ce88 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/common-types.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/common-types.json @@ -87,8 +87,7 @@ "properties": { "code": { "description": "Error code.", - "type": "integer", - "format": "int32", + "type": "string", "readOnly": true }, "message": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json index 3c40802b76bf..aebba7db13f3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json @@ -16,7 +16,7 @@ "validTill": "2020-12-08T05:55:59.4394737Z" }, "error": { - "code": 0, + "code": "0", "message": null } } From c2103f69ae48efe1069e90d546e1d6961c7a78ba Mon Sep 17 00:00:00 2001 From: alprosms <92699124+alprosms@users.noreply.github.com> Date: Wed, 3 May 2023 22:29:41 -0700 Subject: [PATCH 14/79] Dev cost management microsoft.cost management 2023 04 01 preview (#23334) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Adds base for updating Microsoft.CostManagement from version stable/2022-10-01 to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Adding Budgets API translated from 2022-10-01 stable version of Micro… (#22866) * Adding Budgets API translated from 2022-10-01 stable version of Microsoft.Consumption/budgets * Updating api-version in examples to 2023-04-01-preview * Adding costmanagement.budgets.json to readme * Addressing Swagger LintDiff errors * Updating budget name pattern * Adding suppression for R4011 * Adding budget name pattern regex for only alphanumeric, underscore, or hyphen characters * fixing readme.go.md for budgets * removing "object" type from notifications dictionary keys * removing tags * removing mismatching enum values * updating notifications key type * Revert "updating notifications key type" This reverts commit eeb504b9016fb2214811e279da4ee318c37f6652. * Revert "removing mismatching enum values" This reverts commit cba0132bac27f831c90ef8cfca836c8853680000. * updates to enum name * Removing incorrect/outdated description info * fixing BudgetsList example * Updating example Ids to use Microsoft.CostManagement RP * updating min & max length of budget name per conversations with PMs * Adding suppressions for DeleteOperationResponses, TopLevelResourcesListBySubscription, and NoDuplicatePathsForScopeParameter * fixing indentation in readme * fixing formatting of suppressions in readme * Adding paging back in, specifying as null for future use * Adding support for RU Alerts in new Budgets API version (#23140) * Updating budgets swagger definition to include modifications from RU Alert category * Adding new examples for all scenarios of RU Alerts, added new examples for all scopes for Cost Budgets * Spelling & lintdiff fixes * prettier-fix * Added more descriptions, and some light markdown to larger descripitons * Addressing comments * prettier-fix * Updating description for amount property * addressing Shravan's offline comments * spell check * removing aws scopes from scope description * Addressing comments from internal review, removed legacy tags for EA * Alexprosak microsoft.cost management 2023 04 01 preview (#23362) * Updating readme default tag * specifiying the word "update" in 200 response for budget createorupdate * updating tags to package-preview-2023-04-01 * readme test * Revert "readme test" This reverts commit 566e2e6dbcecc8ed3d0c31770788abcaed4840f8. * Revert "updating tags to package-preview-2023-04-01" This reverts commit f9cf3fe3474820afaad0163800aa2548343fae62. * Updating readme with previous apis not included and updated to current version * Revert "Updating readme with previous apis not included and updated to current version" This reverts commit bb879469fea9bf11852334822369310ee6a64534. * Alexprosak cost management microsoft.cost management 2023 04 01 preview (#23770) * changing azure-sdk-for-net to azure-sdk-for-net-track2 per ask from comment on main branch PR * Adding in descriptions + examples for RU Alerts support at the customer scope * fixing json formatting * fixing example references * Updating costmanagementproxyresource to reference ARM common proxy resource. Minor formatting change on scope parameter * Updating common-types with updates to common-types from 2022-10-01 version * prettier-fix * Alprosms cost management microsoft.cost management 2023 04 01 preview (#23795) * updating costdetailreport swaggers from recent changes to 2022-10-01 version * suppressing invalid LintDiff errors --- .../2023-04-01-preview/common-types.json | 222 ++ .../costmanagement.benefits.json | 936 ++++++ .../costmanagement.budgets.json | 767 +++++ .../costmanagement.exports.json | 799 +++++ ...tmanagement.generatecostdetailsreport.json | 402 +++ ...management.generatedetailedcostreport.json | 368 ++ .../2023-04-01-preview/costmanagement.json | 2979 +++++++++++++++++ .../costmanagement.pricesheets.json | 189 ++ ...enefitRecommendationsByBillingAccount.json | 122 + .../SavingsPlan-BillingAccount.json | 48 + .../SavingsPlan-BillingProfile.json | 33 + .../SavingsPlan-SavingsPlanId-Monthly.json | 49 + .../SavingsPlan-SavingsPlanOrderId-Daily.json | 32 + .../examples/BillingAccountAlerts.json | 98 + .../BillingAccountDimensionsList.json | 58 + ...lingAccountDimensionsListExpandAndTop.json | 60 + ...illingAccountDimensionsListWithFilter.json | 41 + .../examples/BillingAccountForecast.json | 120 + .../examples/BillingAccountQuery.json | 108 + .../examples/BillingAccountQueryGrouping.json | 70 + .../examples/BillingProfileAlerts.json | 99 + .../examples/BillingProfileForecast.json | 121 + ...eateOrUpdate-Cost-Subscription-Budget.json | 227 ++ ...countEA-AlertRule-ReservationIdFilter.json | 125 + ...-AlertRule-ReservedResourceTypeFilter.json | 125 + ...tilization-BillingAccountEA-AlertRule.json | 95 + ...Profile-AlertRule-ReservationIdFilter.json | 126 + ...-AlertRule-ReservedResourceTypeFilter.json | 126 + ...nUtilization-BillingProfile-AlertRule.json | 96 + ...ustomer-AlertRule-ReservationIdFilter.json | 126 + ...-AlertRule-ReservedResourceTypeFilter.json | 126 + ...rvationUtilization-Customer-AlertRule.json | 96 + .../examples/Budgets/Delete/DeleteBudget.json | 12 + .../Budgets/Get/Cost/Get-Cost-Budget.json | 85 + .../Get-ReservationUtilization-AlertRule.json | 51 + ...ountBudgetsList-EA-CategoryTypeFilter.json | 44 + .../List/EA/BillingAccountBudgetsList-EA.json | 105 + .../List/EA/DepartmentBudgetsList.json | 78 + .../List/EA/EnrollmentAccountBudgetsList.json | 78 + ...untBudgetsList-MCA-CategoryTypeFilter.json | 44 + .../MCA/BillingAccountBudgetsList-MCA.json | 105 + ...ProfileBudgetsList-CategoryTypeFilter.json | 83 + .../List/MCA/BillingProfileBudgetsList.json | 144 + ...ustomerBudgetsList-CategoryTypeFilter.json | 83 + .../Budgets/List/MCA/CustomerBudgetsList.json | 144 + .../List/MCA/InvoiceSectionBudgetsList.json | 79 + .../List/RBAC/ManagementGroupBudgetsList.json | 222 ++ .../List/RBAC/ResourceGroupBudgetsList.json | 153 + .../List/RBAC/SubscriptionBudgetsList.json | 191 ++ ...lsOperationResultsBySubscriptionScope.json | 46 + .../examples/DepartmentAlerts.json | 99 + .../examples/DepartmentDimensionsList.json | 59 + .../DepartmentDimensionsListExpandAndTop.json | 61 + .../DepartmentDimensionsListWithFilter.json | 42 + .../examples/DepartmentForecast.json | 121 + .../examples/DepartmentQuery.json | 109 + .../examples/DepartmentQueryGrouping.json | 71 + .../examples/DismissResourceGroupAlerts.json | 59 + .../examples/DismissSubscriptionAlerts.json | 58 + .../examples/EnrollmentAccountAlerts.json | 99 + .../EnrollmentAccountDimensionsList.json | 47 + ...mentAccountDimensionsListExpandAndTop.json | 61 + ...llmentAccountDimensionsListWithFilter.json | 42 + .../examples/EnrollmentAccountForecast.json | 121 + .../examples/EnrollmentAccountQuery.json | 109 + .../EnrollmentAccountQueryGrouping.json | 78 + .../ExportCreateOrUpdateByBillingAccount.json | 128 + .../ExportCreateOrUpdateByDepartment.json | 129 + ...portCreateOrUpdateByEnrollmentAccount.json | 129 + ...ExportCreateOrUpdateByManagementGroup.json | 128 + .../ExportCreateOrUpdateByResourceGroup.json | 129 + .../ExportCreateOrUpdateBySubscription.json | 128 + .../ExportDeleteByBillingAccount.json | 11 + .../examples/ExportDeleteByDepartment.json | 12 + .../ExportDeleteByEnrollmentAccount.json | 12 + .../ExportDeleteByManagementGroup.json | 11 + .../examples/ExportDeleteByResourceGroup.json | 12 + .../examples/ExportDeleteBySubscription.json | 11 + .../examples/ExportGetByBillingAccount.json | 47 + .../examples/ExportGetByDepartment.json | 48 + .../ExportGetByEnrollmentAccount.json | 48 + .../examples/ExportGetByManagementGroup.json | 47 + .../examples/ExportGetByResourceGroup.json | 48 + .../examples/ExportGetBySubscription.json | 47 + .../examples/ExportRunByBillingAccount.json | 11 + .../examples/ExportRunByDepartment.json | 12 + .../ExportRunByEnrollmentAccount.json | 12 + .../examples/ExportRunByManagementGroup.json | 11 + .../examples/ExportRunByResourceGroup.json | 12 + .../examples/ExportRunBySubscription.json | 11 + .../ExportRunHistoryGetByBillingAccount.json | 100 + .../ExportRunHistoryGetByDepartment.json | 101 + ...xportRunHistoryGetByEnrollmentAccount.json | 101 + .../ExportRunHistoryGetByManagementGroup.json | 100 + .../ExportRunHistoryGetByResourceGroup.json | 101 + .../ExportRunHistoryGetBySubscription.json | 100 + .../examples/ExportsGetByBillingAccount.json | 89 + .../examples/ExportsGetByDepartment.json | 90 + .../ExportsGetByEnrollmentAccount.json | 90 + .../examples/ExportsGetByManagementGroup.json | 89 + .../examples/ExportsGetByResourceGroup.json | 90 + .../examples/ExportsGetBySubscription.json | 89 + .../ExternalBillingAccountAlerts.json | 98 + .../ExternalBillingAccountForecast.json | 109 + .../ExternalBillingAccountsDimensions.json | 57 + .../ExternalBillingAccountsQuery.json | 99 + .../examples/ExternalSubscriptionAlerts.json | 98 + .../ExternalSubscriptionForecast.json | 92 + .../ExternalSubscriptionsDimensions.json | 57 + .../examples/ExternalSubscriptionsQuery.json | 78 + ...riseAgreementCustomerAndBillingPeriod.json | 46 + ...ilsReportByBillingProfileAndInvoiceId.json | 46 + ...llingProfileAndInvoiceIdAndCustomerId.json | 46 + ...tDetailsReportByCustomerAndTimePeriod.json | 52 + ...tailsReportByDepartmentsAndTimePeriod.json | 52 + ...portByEnrollmentAccountsAndTimePeriod.json | 52 + ...ailsReportBySubscriptionAndTimePeriod.json | 52 + ...yBillingAccountLegacyAndBillingPeriod.json | 30 + ...ostReportByBillingProfileAndInvoiceId.json | 30 + ...llingProfileAndInvoiceIdAndCustomerId.json | 31 + ...iledCostReportByCustomerAndTimePeriod.json | 33 + ...CostReportBySubscriptionAndTimePeriod.json | 33 + ...rtOperationResultsBySubscriptionScope.json | 27 + ...ortOperationStatusBySubscriptionScope.json | 25 + ...ervationDetailsReportByBillingAccount.json | 25 + ...ervationDetailsReportByBillingProfile.json | 26 + .../examples/InvoiceSectionAlerts.json | 100 + .../examples/InvoiceSectionForecast.json | 122 + .../MCABillingAccountDimensionsList.json | 46 + ...lingAccountDimensionsListExpandAndTop.json | 60 + ...illingAccountDimensionsListWithFilter.json | 41 + .../examples/MCABillingAccountQuery.json | 108 + .../MCABillingAccountQueryGrouping.json | 70 + .../MCABillingProfileDimensionsList.json | 47 + ...lingProfileDimensionsListExpandAndTop.json | 61 + ...illingProfileDimensionsListWithFilter.json | 42 + .../examples/MCABillingProfileQuery.json | 109 + .../MCABillingProfileQueryGrouping.json | 71 + .../examples/MCACustomerDimensionsList.json | 47 + ...MCACustomerDimensionsListExpandAndTop.json | 61 + .../MCACustomerDimensionsListWithFilter.json | 42 + .../examples/MCACustomerQuery.json | 109 + .../examples/MCACustomerQueryGrouping.json | 71 + .../MCAInvoiceSectionDimensionsList.json | 48 + ...oiceSectionDimensionsListExpandAndTop.json | 62 + ...nvoiceSectionDimensionsListWithFilter.json | 43 + .../examples/MCAInvoiceSectionQuery.json | 110 + .../MCAInvoiceSectionQueryGrouping.json | 72 + .../ManagementGroupDimensionsList.json | 46 + ...gementGroupDimensionsListExpandAndTop.json | 60 + ...nagementGroupDimensionsListWithFilter.json | 41 + .../examples/ManagementGroupQuery.json | 108 + .../ManagementGroupQueryGrouping.json | 77 + .../examples/OperationList.json | 113 + .../examples/PricesheetDownload.json | 23 + .../PricesheetDownloadByBillingProfile.json | 22 + .../examples/PrivateView.json | 69 + .../examples/PrivateViewCreateOrUpdate.json | 185 + .../examples/PrivateViewDelete.json | 10 + .../examples/PrivateViewList.json | 131 + .../examples/ResourceGroupAlerts.json | 99 + .../examples/ResourceGroupDimensionsList.json | 57 + .../examples/ResourceGroupForecast.json | 103 + .../examples/ResourceGroupQuery.json | 97 + .../examples/ResourceGroupQueryGrouping.json | 72 + .../examples/SingleResourceGroupAlert.json | 54 + .../examples/SingleSubscriptionAlert.json | 53 + .../examples/SubscriptionAlerts.json | 98 + .../examples/SubscriptionDimensionsList.json | 59 + .../examples/SubscriptionForecast.json | 120 + .../examples/SubscriptionQuery.json | 108 + .../examples/SubscriptionQueryGrouping.json | 75 + .../examples/ViewByResourceGroup.json | 70 + .../ViewCreateOrUpdateByResourceGroup.json | 186 + .../examples/ViewDeleteByResourceGroup.json | 11 + .../examples/ViewListByResourceGroup.json | 132 + ...eAvailability-private-scheduledAction.json | 18 + ...meAvailability-shared-scheduledAction.json | 17 + ...cheduledAction-createOrUpdate-private.json | 127 + ...scheduledAction-createOrUpdate-shared.json | 134 + .../scheduledAction-delete-private.json | 10 + .../scheduledAction-delete-shared.json | 11 + .../scheduledAction-get-private.json | 51 + .../scheduledAction-get-shared.json | 52 + ...on-insightAlert-createOrUpdate-shared.json | 106 + .../scheduledAction-sendNow-private.json | 9 + .../scheduledAction-sendNow-shared.json | 10 + .../scheduledActions-list-private.json | 89 + .../scheduledActions-list-shared.json | 90 + ...heduledActions-listWithFilter-private.json | 90 + ...cheduledActions-listWithFilter-shared.json | 91 + .../2023-04-01-preview/scheduledActions.json | 931 ++++++ .../resource-manager/readme.go.md | 5 + .../resource-manager/readme.md | 39 +- 194 files changed, 21298 insertions(+), 3 deletions(-) create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/common-types.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.benefits.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatecostdetailsreport.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.pricesheets.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitRecommendationsByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingProfileAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingProfileForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservationIdFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservedResourceTypeFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservationIdFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservedResourceTypeFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Delete/DeleteBudget.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Get/Cost/Get-Cost-Budget.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/DepartmentBudgetsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingProfileBudgetsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/CustomerBudgetsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/CostDetailsOperationResultsBySubscriptionScope.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DismissResourceGroupAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DismissSubscriptionAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountsDimensions.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountsQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionsDimensions.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionsQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/InvoiceSectionAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/InvoiceSectionForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/OperationList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PricesheetDownload.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PricesheetDownloadByBillingProfile.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateView.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewCreateOrUpdate.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewDelete.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SingleResourceGroupAlert.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SingleSubscriptionAlert.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewDeleteByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewListByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-createOrUpdate-private.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-delete-private.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-delete-shared.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-get-private.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-get-shared.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-sendNow-private.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-sendNow-shared.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-list-private.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-list-shared.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-listWithFilter-private.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-listWithFilter-shared.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/scheduledActions.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/common-types.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/common-types.json new file mode 100644 index 000000000000..5a53d4c8c527 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/common-types.json @@ -0,0 +1,222 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01-preview", + "title": "CostManagementClient" + }, + "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.CostManagement/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available cost management REST API operations.", + "x-ms-examples": { + "OperationList": { + "$ref": "./examples/OperationList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorDetailsWithNestedDetails": { + "description": "The details of the error.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ErrorDetails" + } + ], + "properties": { + "details": { + "type": "array", + "readOnly": true, + "description": "The additional details of the error.", + "items": { + "$ref": "#/definitions/ErrorDetailsWithNestedDetails" + }, + "x-ms-identifiers": [] + } + } + }, + "ErrorResponseWithNestedDetails": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetailsWithNestedDetails" + } + } + }, + "CostManagementOperation": { + "description": "A Cost management REST API operation.", + "type": "object", + "properties": { + "id": { + "description": "Operation id: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Operation" + } + ] + }, + "OperationListResult": { + "description": "Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results.", + "type": "object", + "properties": { + "value": { + "description": "List of cost management operations supported by the Microsoft.CostManagement resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CostManagementOperation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "CostManagementProxyResource": { + "description": "The Resource model definition.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "eTag": { + "type": "string", + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." + } + }, + "x-ms-azure-resource": true + }, + "DownloadURL": { + "description": "The URL to download the generated report.", + "type": "object", + "properties": { + "expiryTime": { + "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "validTill": { + "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", + "type": "string", + "format": "date-time" + }, + "downloadUrl": { + "description": "The URL to download the generated report.", + "type": "string" + } + } + } + }, + "parameters": { + "billingAccountIdParameter": { + "description": "Billing account ID", + "in": "path", + "name": "billingAccountId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingProfileIdParameter": { + "description": "Billing profile ID.", + "in": "path", + "name": "billingProfileId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.benefits.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.benefits.json new file mode 100644 index 000000000000..2f807bebaa7b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.benefits.json @@ -0,0 +1,936 @@ +{ + "swagger": "2.0", + "info": { + "title": "CostManagementClient", + "description": "CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions.", + "version": "2023-04-01-preview" + }, + "tags": [ + { + "name": "Benefits API", + "description": "APIs for getting benefit recommendations and benefit utilization summaries." + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{billingScope}/providers/Microsoft.CostManagement/benefitRecommendations": { + "get": { + "tags": [ + "BenefitRecommendations" + ], + "description": "List of recommendations for purchasing savings plan.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" + }, + "x-ms-examples": { + "BenefitRecommendationsBillingAccountList": { + "$ref": "./examples/BenefitRecommendationsByBillingAccount.json" + } + }, + "operationId": "BenefitRecommendations_List", + "parameters": [ + { + "$ref": "#/parameters/benefitRecommendationsFilterParameter" + }, + { + "name": "$orderby", + "in": "query", + "description": "May be used to order the recommendations by: properties/armSkuName. For the savings plan, the results are in order by default. There is no need to use this clause.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "$expand", + "in": "query", + "description": "May be used to expand the properties by: properties/usage, properties/allRecommendationDetails", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingScopeBenefitRecommendationParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/benefitRecommendationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { + "get": { + "tags": [ + "BenefitUtilizationSummaries" + ], + "operationId": "BenefitUtilizationSummaries_ListByBillingAccountId", + "description": "Lists savings plan utilization summaries for the enterprise agreement scope. Supported at grain values: 'Daily' and 'Monthly'.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common-types.json#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "name": "filter", + "in": "query", + "description": "Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SavingsPlanUtilizationSummaries-BillingAccount": { + "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { + "get": { + "tags": [ + "BenefitUtilizationSummaries" + ], + "operationId": "BenefitUtilizationSummaries_ListByBillingProfileId", + "description": "Lists savings plan utilization summaries for billing profile. Supported at grain values: 'Daily' and 'Monthly'.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common-types.json#/parameters/billingAccountIdParameter" + }, + { + "$ref": "common-types.json#/parameters/billingProfileIdParameter" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "name": "filter", + "in": "query", + "description": "Supports filtering by properties/benefitId, properties/benefitOrderId and properties/usageDate.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SavingsPlanUtilizationSummaries-BillingProfile": { + "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { + "get": { + "tags": [ + "BenefitUtilizationSummaries" + ], + "operationId": "BenefitUtilizationSummaries_ListBySavingsPlanOrder", + "description": "Lists the savings plan utilization summaries for daily or monthly grain.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" + }, + "x-ms-examples": { + "SavingsPlanUtilizationSummariesDaily": { + "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "Supports filtering by properties/usageDate.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "$ref": "#/parameters/savingsPlanOrderIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.BillingBenefits/savingsPlanOrders/{savingsPlanOrderId}/savingsPlans/{savingsPlanId}/providers/Microsoft.CostManagement/benefitUtilizationSummaries": { + "get": { + "tags": [ + "BenefitUtilizationSummaries" + ], + "operationId": "BenefitUtilizationSummaries_ListBySavingsPlanId", + "description": "Lists the savings plan utilization summaries for daily or monthly grain.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/cost-management/" + }, + "x-ms-examples": { + "SavingsPlanUtilizationSummariesMonthlyWithSavingsPlanId": { + "$ref": "./examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "Supports filtering by properties/usageDate.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/grainParameter" + }, + { + "$ref": "#/parameters/savingsPlanOrderIdParameter" + }, + { + "$ref": "#/parameters/savingsPlanIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BenefitUtilizationSummariesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "benefitRecommendationsListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The list of benefit recommendations.", + "readOnly": true, + "items": { + "$ref": "#/definitions/benefitRecommendationModel" + } + }, + "nextLink": { + "type": "string", + "description": "The link (URL) to the next page of results.", + "readOnly": true, + "format": "uri" + } + }, + "description": "Result of listing benefit recommendations." + }, + "benefitRecommendationModel": { + "type": "object", + "description": "benefit plan recommendation details.", + "allOf": [ + { + "$ref": "#/definitions/BenefitResource" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/benefitRecommendationProperties" + } + } + }, + "benefitRecommendationProperties": { + "type": "object", + "description": "The properties of the benefit recommendations.", + "discriminator": "scope", + "properties": { + "firstConsumptionDate": { + "type": "string", + "description": "The first usage date used for looking back for computing the recommendations.", + "readOnly": true, + "format": "date-time" + }, + "lastConsumptionDate": { + "type": "string", + "description": "The last usage date used for looking back for computing the recommendations.", + "readOnly": true, + "format": "date-time" + }, + "lookBackPeriod": { + "description": "The number of days of usage evaluated for computing the recommendations.", + "$ref": "#/definitions/LookBackPeriod" + }, + "totalHours": { + "type": "integer", + "format": "int32", + "description": "The total hours for which the cost is covered. Its equal to number of records in a property 'properties/usage/charges'.", + "readOnly": true + }, + "usage": { + "type": "object", + "description": "On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", + "$ref": "#/definitions/recommendationUsageDetails" + }, + "armSkuName": { + "description": "ARM SKU name. 'Compute_Savings_Plan' for SavingsPlan.", + "type": "string", + "readOnly": true + }, + "term": { + "description": "Term period of the benefit. For example, P1Y or P3Y.", + "$ref": "#/definitions/Term" + }, + "commitmentGranularity": { + "description": "Grain of the proposed commitment amount. Supported values: 'Hourly'", + "$ref": "#/definitions/Grain" + }, + "currencyCode": { + "type": "string", + "description": "An ISO 4217 currency code identifier for the costs and savings amounts.", + "readOnly": true + }, + "costWithoutBenefit": { + "type": "number", + "format": "decimal", + "description": "The current cost without benefit, corresponds to 'totalHours' in the look-back period.", + "readOnly": true + }, + "recommendationDetails": { + "type": "object", + "description": "The details of the proposed recommendation.", + "$ref": "#/definitions/allSavingsBenefitDetails" + }, + "allRecommendationDetails": { + "type": "object", + "description": "The list of all benefit recommendations with the recommendation details.", + "readOnly": true, + "$ref": "#/definitions/allSavingsList" + }, + "scope": { + "description": "Benefit scope. For example, Single or Shared.", + "$ref": "#/definitions/RecommendationScope" + } + }, + "required": [ + "scope" + ] + }, + "singleScopeBenefitRecommendationProperties": { + "type": "object", + "description": "The properties of the benefit recommendations when scope is 'Single'.", + "x-ms-discriminator-value": "Single", + "properties": { + "subscriptionId": { + "type": "string", + "description": "The subscription ID that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope.", + "readOnly": true + }, + "resourceGroup": { + "type": "string", + "description": "The resource group that this single scope recommendation is for. Applicable only if recommendation is for 'Single' scope and 'ResourceGroup' request scope.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/benefitRecommendationProperties" + } + ] + }, + "sharedScopeBenefitRecommendationProperties": { + "type": "object", + "description": "The properties of the benefit recommendation when scope is 'Shared'.", + "x-ms-discriminator-value": "Shared", + "allOf": [ + { + "$ref": "#/definitions/benefitRecommendationProperties" + } + ] + }, + "recommendationUsageDetails": { + "type": "object", + "description": "On-demand charges between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", + "properties": { + "usageGrain": { + "description": "The grain of the usage. Supported values: 'Hourly'", + "$ref": "#/definitions/Grain" + }, + "charges": { + "type": "array", + "description": "On-demand charges for each hour between firstConsumptionDate and lastConsumptionDate that were used for computing benefit recommendations.", + "readOnly": true, + "items": { + "type": "number", + "format": "decimal" + } + } + } + }, + "allSavingsList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "The list of benefit recommendations with the recommendation details..", + "readOnly": true, + "items": { + "$ref": "#/definitions/allSavingsBenefitDetails" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The link (URL) to the next page of results.", + "readOnly": true, + "format": "uri" + } + }, + "description": "The list of all benefit recommendations with the recommendation details." + }, + "allSavingsBenefitDetails": { + "description": "Benefit recommendation details.", + "type": "object", + "properties": { + "overageCost": { + "type": "number", + "format": "decimal", + "description": "The difference between total cost and benefit cost for the 'totalHours' in the look-back period.", + "readOnly": true + }, + "benefitCost": { + "type": "number", + "format": "decimal", + "description": "The estimated cost with benefit for the 'totalHours' in the look-back period. It's equal to (commitmentAmount * totalHours)", + "readOnly": true + }, + "totalCost": { + "type": "number", + "format": "decimal", + "description": "Total cost, which is sum of benefit cost and overage cost.", + "readOnly": true + }, + "savingsAmount": { + "type": "number", + "format": "decimal", + "description": "The amount saved for the 'totalHours' in the look-back period, by purchasing the recommended quantity of the benefit.", + "readOnly": true + }, + "savingsPercentage": { + "type": "number", + "format": "decimal", + "description": "The savings in percentage for the 'totalHours' in the look-back period, by purchasing the recommended quantity of benefit.", + "readOnly": true + }, + "coveragePercentage": { + "description": "Estimated benefit coverage percentage for the 'totalHours' in the look-back period, with this commitment.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "commitmentAmount": { + "description": "The commitment amount at the commitmentGranularity.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "averageUtilizationPercentage": { + "description": "Estimated average utilization percentage for the 'totalHours' in the look-back period, with this commitment.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "wastageCost": { + "description": "Estimated unused portion of the 'benefitCost'.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "BenefitKind": { + "type": "string", + "description": "Kind/type of the benefit.", + "enum": [ + "IncludedQuantity", + "Reservation", + "SavingsPlan" + ], + "x-ms-enum": { + "name": "benefitKind", + "modelAsString": true, + "values": [ + { + "value": "IncludedQuantity", + "description": "Benefit is IncludedQuantity.", + "name": "IncludedQuantity" + }, + { + "value": "Reservation", + "description": "Benefit is Reservation.", + "name": "Reservation" + }, + { + "value": "SavingsPlan", + "description": "Benefit is SavingsPlan.", + "name": "SavingsPlan" + } + ] + } + }, + "RecommendationScope": { + "type": "string", + "description": "Kind of the recommendation scope.", + "enum": [ + "Single", + "Shared" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true, + "values": [ + { + "value": "Single", + "description": "Single scope recommendation.", + "name": "Single" + }, + { + "value": "Shared", + "description": "Shared scope recommendation.", + "name": "Shared" + } + ] + } + }, + "Grain": { + "type": "string", + "description": "Grain which corresponds to value.", + "enum": [ + "Hourly", + "Daily", + "Monthly" + ], + "x-ms-enum": { + "name": "grain", + "modelAsString": true, + "values": [ + { + "value": "Hourly", + "description": "Hourly grain corresponds to value per hour.", + "name": "Hourly" + }, + { + "value": "Daily", + "description": "Hourly grain corresponds to value per day.", + "name": "Daily" + }, + { + "value": "Monthly", + "description": "Hourly grain corresponds to value per month.", + "name": "Monthly" + } + ] + } + }, + "Term": { + "type": "string", + "description": "Grain which corresponds to value.", + "enum": [ + "P1Y", + "P3Y" + ], + "x-ms-enum": { + "name": "term", + "modelAsString": true, + "values": [ + { + "value": "P1Y", + "description": "Benefit term is 1 year.", + "name": "P1Y" + }, + { + "value": "P3Y", + "description": "Benefit term is 3 years.", + "name": "P3Y" + } + ] + } + }, + "LookBackPeriod": { + "type": "string", + "description": "The number of days used to look back.", + "enum": [ + "Last7Days", + "Last30Days", + "Last60Days" + ], + "x-ms-enum": { + "name": "lookBackPeriod", + "modelAsString": true, + "values": [ + { + "value": "Last7Days", + "description": "7 days used to look back.", + "name": "Last7Days" + }, + { + "value": "Last30Days", + "description": "30 days used to look back.", + "name": "Last30Days" + }, + { + "value": "Last60Days", + "description": "60 days used to look back.", + "name": "Last60Days" + } + ] + } + }, + "BenefitResource": { + "type": "object", + "description": "The benefit resource model definition.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "kind": { + "description": "Reservation or SavingsPlan.", + "$ref": "#/definitions/BenefitKind" + } + }, + "x-ms-azure-resource": true + }, + "BenefitUtilizationSummariesListResult": { + "description": "List of benefit utilization summaries.", + "type": "object", + "properties": { + "value": { + "description": "The list of benefit utilization summaries.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BenefitUtilizationSummary" + } + }, + "nextLink": { + "description": "The link (URL) to the next page of results.", + "type": "string", + "readOnly": true, + "format": "uri" + } + } + }, + "BenefitUtilizationSummary": { + "description": "Benefit utilization summary resource.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/Resource" + } + ], + "properties": { + "kind": { + "description": "Supported values: 'SavingsPlan'.", + "$ref": "#/definitions/BenefitKind" + } + } + }, + "BenefitUtilizationSummaryProperties": { + "description": "The properties of a benefit utilization summary.", + "type": "object", + "properties": { + "armSkuName": { + "description": "ARM SKU name. For example, 'Compute_Savings_Plan' for savings plan.", + "type": "string", + "readOnly": true + }, + "benefitId": { + "description": "The benefit ID is the identifier of the benefit.", + "type": "string", + "readOnly": true + }, + "benefitOrderId": { + "description": "The benefit order ID is the identifier for a benefit purchase.", + "type": "string", + "readOnly": true + }, + "benefitType": { + "description": "The benefit type. Supported values: 'SavingsPlan'.", + "$ref": "#/definitions/BenefitKind" + }, + "usageDate": { + "description": "Date corresponding to the utilization summary record. If the grain of data is monthly, value for this field will be first day of the month.", + "type": "string", + "format": "date-time", + "readOnly": true + } + } + }, + "IncludedQuantityUtilizationSummary": { + "description": "Included Quantity utilization summary resource.", + "x-ms-discriminator-value": "IncludedQuantity", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BenefitUtilizationSummary" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IncludedQuantityUtilizationSummaryProperties", + "title": "Benefit utilization summary for benefit kind Included Quantity." + } + } + }, + "IncludedQuantityUtilizationSummaryProperties": { + "type": "object", + "description": "Included Quantity utilization summary properties.", + "allOf": [ + { + "$ref": "#/definitions/BenefitUtilizationSummaryProperties" + } + ], + "properties": { + "utilizationPercentage": { + "description": "This is the utilized percentage for the benefit ID.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + }, + "SavingsPlanUtilizationSummary": { + "description": "Savings plan utilization summary resource.", + "x-ms-discriminator-value": "SavingsPlan", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BenefitUtilizationSummary" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SavingsPlanUtilizationSummaryProperties", + "title": "Benefit utilization Summary for benefit kind savings plan." + } + } + }, + "SavingsPlanUtilizationSummaryProperties": { + "type": "object", + "description": "Savings plan utilization summary properties.", + "allOf": [ + { + "$ref": "#/definitions/BenefitUtilizationSummaryProperties" + } + ], + "properties": { + "avgUtilizationPercentage": { + "description": "This is the average hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-04-01-preview and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the avgUtilizationPercentage value will be equal to the average of the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "minUtilizationPercentage": { + "description": "This is the minimum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-04-01-preview and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the minUtilizationPercentage value will be equal to the smallest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the lowest utilization percentage was 10% at hour 4, then the value for the minUtilizationPercentage in the response will be 10%.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "maxUtilizationPercentage": { + "description": "This is the maximum hourly utilization for each date range that corresponds to given grain (Daily, Monthly). Suppose the API call is for usageDate > 2023-04-01-preview and usageDate < 2022-10-31 at a daily granularity. There will be one record per benefit id for each day. For a single day, the maxUtilizationPercentage value will be equal to the largest in the set of values where the set contains 24 utilization percentage entries one for each hour in a specific day. If on the day 2022-10-18, the largest utilization percentage was 90% at hour 5, then the value for the maxUtilizationPercentage in the response will be 90%.", + "type": "number", + "format": "decimal", + "readOnly": true + } + } + } + }, + "parameters": { + "billingScopeBenefitRecommendationParameter": { + "name": "billingScope", + "in": "path", + "description": "The scope associated with benefit recommendation operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for enterprise agreement scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billing profile scope", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "benefitRecommendationsFilterParameter": { + "name": "$filter", + "in": "query", + "description": "Can be used to filter benefitRecommendations by: properties/scope with allowed values ['Single', 'Shared'] and default value 'Shared'; and properties/lookBackPeriod with allowed values ['Last7Days', 'Last30Days', 'Last60Days'] and default value 'Last60Days'; properties/term with allowed values ['P1Y', 'P3Y'] and default value 'P3Y'; properties/subscriptionId; properties/resourceGroup", + "type": "string", + "x-ms-parameter-location": "method" + }, + "savingsPlanOrderIdParameter": { + "description": "Savings plan order ID.", + "in": "path", + "name": "savingsPlanOrderId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "savingsPlanIdParameter": { + "description": "Savings plan ID.", + "in": "path", + "name": "savingsPlanId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "grainParameter": { + "description": "Grain.", + "in": "query", + "required": false, + "x-ms-parameter-location": "method", + "type": "string", + "name": "grainParameter", + "enum": [ + "Hourly", + "Daily", + "Monthly" + ], + "x-ms-enum": { + "name": "grainParameter", + "modelAsString": true, + "values": [ + { + "value": "Hourly", + "description": "Hourly grain corresponds to value per hour.", + "name": "Hourly" + }, + { + "value": "Daily", + "description": "Hourly grain corresponds to value per day.", + "name": "Daily" + }, + { + "value": "Monthly", + "description": "Hourly grain corresponds to value per month.", + "name": "Monthly" + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json new file mode 100644 index 000000000000..bdecff29c10d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json @@ -0,0 +1,767 @@ +{ + "swagger": "2.0", + "info": { + "title": "CostManagementClient", + "description": "CostManagement management client provides access to CostManagement resources for Azure Enterprise Subscriptions.", + "version": "2023-04-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.CostManagement/budgets": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_List", + "description": "Lists all budgets for the defined scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" + }, + "x-ms-examples": { + "SubscriptionBudgetsList": { + "$ref": "./examples/Budgets/List/RBAC/SubscriptionBudgetsList.json" + }, + "ResourceGroupBudgetsList": { + "$ref": "./examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json" + }, + "ManagementGroupBudgetsList": { + "$ref": "./examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json" + }, + "BillingAccountBudgetsList-EA": { + "$ref": "./examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json" + }, + "BillingAccountBudgetsList-EA-CategoryTypeFilter": { + "$ref": "./examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json" + }, + "DepartmentBudgetsList-EA": { + "$ref": "./examples/Budgets/List/EA/DepartmentBudgetsList.json" + }, + "EnrollmentAccountBudgetsList-EA": { + "$ref": "./examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json" + }, + "BillingAccountBudgetsList-MCA": { + "$ref": "./examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json" + }, + "BillingAccountBudgetsList-MCA-CategoryTypeFilter": { + "$ref": "./examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json" + }, + "BillingProfileBudgetsList-MCA": { + "$ref": "./examples/Budgets/List/MCA/BillingProfileBudgetsList.json" + }, + "BillingProfileBudgetsList-MCA-CategoryTypeFilter": { + "$ref": "./examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json" + }, + "InvoiceSectionBudgetsList-MCA": { + "$ref": "./examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json" + }, + "CustomerBudgetsList-MCA-CSP": { + "$ref": "./examples/Budgets/List/MCA/CustomerBudgetsList.json" + }, + "CustomerBudgetsList-MCA-CSP-CategoryTypeFilter": { + "$ref": "./examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/budgetCategoryFilterParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BudgetsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/budgets/{budgetName}": { + "get": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_Get", + "description": "Gets the budget for the scope by budget name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" + }, + "x-ms-examples": { + "Get-Cost-Budget": { + "$ref": "./examples/Budgets/Get/Cost/Get-Cost-Budget.json" + }, + "Get-ReservationUtilization-AlertRule": { + "$ref": "./examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_CreateOrUpdate", + "description": "The operation to create or update a budget. You can optionally provide an eTag if desired as a form of concurrency control. To obtain the latest eTag for a given budget, perform a get operation prior to your put operation.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" + }, + "x-ms-examples": { + "CreateOrUpdate-Cost-Subscription-Budget": { + "$ref": "./examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule.json": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservedResourceTypeFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservedResourceTypeFilter.json" + }, + "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservationIdFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservationIdFilter.json" + }, + "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule.json": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule.json" + }, + "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservedResourceTypeFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservedResourceTypeFilter.json" + }, + "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservationIdFilter": { + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservationIdFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Budget" + }, + "description": "Parameters supplied to the Create Budget operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded and the Budget update is complete.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Budget" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Budgets" + ], + "operationId": "Budgets_Delete", + "description": "The operation to delete a budget.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/CostManagement/" + }, + "x-ms-examples": { + "DeleteBudget": { + "$ref": "./examples/Budgets/Delete/DeleteBudget.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeBudgetParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/budgetNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "BudgetsListResult": { + "description": "Result of listing budgets. It contains a list of available budgets in the scope provided.", + "type": "object", + "properties": { + "value": { + "description": "The list of budgets.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Budget" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.\r\nIt's null for now, added for future use.", + "type": "string", + "readOnly": true + } + } + }, + "Budget": { + "description": "A budget resource.", + "type": "object", + "allOf": [ + { + "$ref": "common-types.json#/definitions/CostManagementProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BudgetProperties", + "title": "Budget properties" + } + } + }, + "BudgetProperties": { + "description": "The properties of the budget.", + "type": "object", + "properties": { + "category": { + "description": "The category of the budget.\n- 'Cost' defines a Budget.\n- 'ReservationUtilization' defines a Reservation Utilization Alert Rule.", + "type": "string", + "enum": [ + "Cost", + "ReservationUtilization" + ], + "x-ms-enum": { + "name": "CategoryType", + "modelAsString": true, + "values": [ + { + "value": "Cost", + "description": "A Budget that evaluates monetary cost of Azure resources against an amount, and alerts based on a configured notification threshold.", + "name": "Cost" + }, + { + "value": "ReservationUtilization", + "description": "An Alert Rule that evaluates the utilization percentage of Azure Reservations, and alerts based on a configured notification threshold." + } + ] + } + }, + "amount": { + "description": "The total amount of cost to track with the budget.\n\n Supported for CategoryType(s): Cost.\n\n Required for CategoryType(s): Cost.", + "type": "number" + }, + "timeGrain": { + "description": "The time covered by a budget. Tracking of the amount will be reset based on the time grain.\n\nSupported for CategoryType(s): Cost, ReservationUtilization.\n\n Supported timeGrainTypes for **CategoryType: Cost**\n\n- Monthly\n- Quarterly\n- Annually\n- BillingMonth*\n- BillingQuarter*\n- BillingAnnual*\n\n *only supported for Web Direct customers.\n\n Supported timeGrainTypes for **CategoryType: ReservationUtilization**\n- Last7Days\n- Last30Days\n\n Required for CategoryType(s): Cost, ReservationUtilization.", + "type": "string", + "enum": [ + "Monthly", + "Quarterly", + "Annually", + "BillingMonth", + "BillingQuarter", + "BillingAnnual", + "Last7Days", + "Last30Days" + ], + "x-ms-enum": { + "name": "TimeGrainType", + "modelAsString": true, + "values": [ + { + "value": "Monthly", + "description": "The budget will track costs in the current calendar month against the amount.\n\n Supported for CategoryType: Cost only.", + "name": "Monthly" + }, + { + "value": "Quarterly", + "description": "The budget will track costs in the current calendar quarter against the amount.\n\n Supported for CategoryType: Cost only.", + "name": "Quarterly" + }, + { + "value": "Annually", + "description": "The budget will track costs in the current calendar year against the amount.\n\n Supported for CategoryType: Cost only.", + "name": "Annually" + }, + { + "value": "BillingMonth", + "description": "The budget will track costs in the current billing month against the amount.\n\n Supported for CategoryType: Cost and Web Direct customers only.", + "name": "BillingMonth" + }, + { + "value": "BillingQuarter", + "description": "The budget will track costs in the current billing quarter against the amount.\n\n Supported for CategoryType: Cost and Web Direct customers only.", + "name": "BillingQuarter" + }, + { + "value": "BillingAnnual", + "description": "The budget will track costs in the current billing year against the amount.\n\n Supported for CategoryType: Cost and Web Direct customers only.", + "name": "BillingAnnual" + }, + { + "value": "Last7Days", + "description": "The Reservation Utilization Alert Rule will evaluate reservations based on their 7-Day utilization percentage.\n\n Supported for CategoryType: ReservationUtilization only.", + "name": "Last7Days" + }, + { + "value": "Last30Days", + "description": "The Reservation Utilization Alert Rule will evaluate reservations based on their 30-Day utilization percentage.\n\n Supported for CategoryType: ReservationUtilization only.", + "name": "Last30Days" + } + ] + } + }, + "timePeriod": { + "description": "The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Required for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "$ref": "#/definitions/BudgetTimePeriod" + }, + "filter": { + "description": "May be used to filter budgets by user-specified dimensions and/or tags.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "$ref": "#/definitions/BudgetFilter" + }, + "currentSpend": { + "description": "The current amount of cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", + "$ref": "#/definitions/CurrentSpend", + "readOnly": true + }, + "notifications": { + "type": "object", + "description": "Dictionary of notifications associated with the budget.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n- Constraints for **CategoryType: Cost** - Budget can have up to 5 notifications with thresholdType: Actual and 5 notifications with thresholdType: Forecasted.\n- Constraints for **CategoryType: ReservationUtilization** - Only one notification allowed. thresholdType is not applicable.", + "additionalProperties": { + "$ref": "#/definitions/Notification" + }, + "maxItems": 5 + }, + "forecastSpend": { + "description": "The forecasted cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", + "$ref": "#/definitions/ForecastSpend", + "readOnly": true + } + }, + "required": [ + "category", + "timeGrain", + "timePeriod" + ] + }, + "BudgetTimePeriod": { + "description": "The time period that defines the active period of the budget. The budget will evaluate data on or after the startDate and will expire on the endDate.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Required for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "properties": { + "startDate": { + "description": "The start date for the budget.\n\n- Constraints for **CategoryType: Cost** - Must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period.\n\n- Constraints for **CategoryType: ReservationUtilization** - Must be on or after the current date and less than the end date.", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The end date for the budget.\n\n- Constraints for **CategoryType: Cost** - No constraints. If not provided, we default this to 10 years from the start date.\n\n- Constraints for **CategoryType: ReservationUtilization** - End date cannot be more than 3 years after the start date.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "startDate" + ] + }, + "BudgetFilter": { + "description": "May be used to filter budgets by user-specified dimensions and/or tags.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.\n\n Supported for CategoryType(s): Cost.", + "type": "array", + "items": { + "$ref": "#/definitions/BudgetFilterProperties" + }, + "x-ms-identifiers": [], + "minItems": 0 + }, + "dimensions": { + "description": "Has comparison expression for a dimension.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization** \n- ReservationId\n- ReservedResourceType", + "$ref": "#/definitions/BudgetComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag.\n\n Supported for CategoryType(s): Cost.", + "$ref": "#/definitions/BudgetComparisonExpression" + } + } + }, + "BudgetFilterProperties": { + "description": "The Dimensions or Tags to filter a budget by.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "properties": { + "dimensions": { + "description": "Has comparison expression for a dimension.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\nSupported dimension names for **CategoryType: ReservationUtilization** \n- ReservationId\n- ReservedResourceType", + "$ref": "#/definitions/BudgetComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag.\n\n Supported for CategoryType(s): Cost.", + "$ref": "#/definitions/BudgetComparisonExpression" + } + } + }, + "BudgetComparisonExpression": { + "description": "The comparison expression to be used in the budgets.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "BudgetOperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "CurrentSpend": { + "description": "The current amount of cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", + "type": "object", + "properties": { + "amount": { + "description": "The total amount of cost which is being tracked by the budget.", + "type": "number", + "readOnly": true + }, + "unit": { + "description": "The unit of measure for the budget amount.", + "type": "string", + "readOnly": true + } + } + }, + "ForecastSpend": { + "description": "The forecasted cost which is being tracked for a budget.\n\n Supported for CategoryType(s): Cost.", + "type": "object", + "properties": { + "amount": { + "description": "The forecasted cost for the total time period which is being tracked by the budget. This value is only provided if the budget contains a forecast alert type.", + "type": "number", + "readOnly": true + }, + "unit": { + "description": "The unit of measure for the budget amount.", + "type": "string", + "readOnly": true + } + } + }, + "Notification": { + "description": "The notification associated with a budget.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "object", + "properties": { + "enabled": { + "description": "The notification is enabled or not.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "boolean" + }, + "operator": { + "description": "The comparison operator.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n Supported operators for **CategoryType: Cost**\n- GreaterThan\n- GreaterThanOrEqualTo\n\n Supported operators for **CategoryType: ReservationUtilization**\n- LessThan", + "type": "string", + "enum": [ + "EqualTo", + "GreaterThan", + "GreaterThanOrEqualTo", + "LessThan" + ], + "x-ms-enum": { + "name": "BudgetNotificationOperatorType", + "modelAsString": true, + "values": [ + { + "value": "EqualTo", + "description": "Notification will be triggered if the evaluated cost is the same as threshold value. Note: It’s not recommended to use this OperatorType as there’s low chance of cost being exactly the same as threshold value, leading to missing of your alert. This OperatorType will be deprecated in future.\n\n Supported for CategoryType(s): Cost.", + "name": "EqualTo" + }, + { + "value": "GreaterThan", + "description": "Notification will be triggered if the evaluated cost is greater than the threshold value. Note: This is the recommended OperatorType while configuring Budget Alert.\n\n Supported for CategoryType(s): Cost.", + "name": "GreaterThan" + }, + { + "value": "GreaterThanOrEqualTo", + "description": "Notification will be triggered if the evaluated cost is greater than or equal to the threshold value.\n\n Supported for CategoryType(s): Cost.", + "name": "GreaterThanOrEqualTo" + }, + { + "value": "LessThan", + "description": "Notification will be triggered if any Reservations in the scope of the Reservation Utilization Alert Rule have a utilization less than the threshold percentage.\n\n Supported for CategoryType(s): ReservationUtilization.", + "name": "LessThan" + } + ] + } + }, + "threshold": { + "description": "Threshold value associated with a notification. It is always percent with a maximum of 2 decimal places.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.\n\n **CategoryType: Cost** - Must be between 0 and 1000. Notification is sent when the cost exceeded the threshold.\n\n **CategoryType: ReservationUtilization** - Must be between 0 and 100. Notification is sent when a reservation has a utilization percentage below the threshold.", + "type": "number" + }, + "frequency": { + "description": "Frequency of a notification. Represents how long the notification will be silent after triggering an alert for a threshold breach. If not specified, the frequency will be set by default based on the timeGrain (Weekly when timeGrain: Last7Days, Monthly when timeGrain: Last30Days).\n\n Supported for CategoryType(s): ReservationUtilization.", + "type": "string", + "enum": [ + "Daily", + "Weekly", + "Monthly" + ], + "x-ms-enum": { + "name": "Frequency", + "modelAsString": true, + "values": [ + { + "value": "Daily", + "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent until the next calendar day.", + "name": "Daily" + }, + { + "value": "Weekly", + "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent for 7 calendar days.", + "name": "Weekly" + }, + { + "value": "Monthly", + "description": "After the threshold breaches and an Alert is fired, no further alerts will be sent for 30 calendar days.", + "name": "Monthly" + } + ] + } + }, + "contactEmails": { + "description": "Email addresses to send the notification to when the threshold is breached. Must have at least one contact email or contact group specified at the Subscription or Resource Group scopes. All other scopes must have at least one contact email specified.\n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 50 + }, + "contactRoles": { + "description": "Subscription or Resource Group scopes only. Contact roles to send the notification to when the threshold is breached.\n\n Supported for CategoryType(s): Cost.", + "type": "array", + "items": { + "type": "string" + } + }, + "contactGroups": { + "description": "Subscription or Resource Group scopes only. Action groups to send the notification to when the threshold is exceeded. Must be provided as a fully qualified Azure resource id.\n\n Supported for CategoryType(s): Cost.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 0, + "maxItems": 50 + }, + "thresholdType": { + "description": "The type of threshold.\n\n Supported for CategoryType(s): Cost.", + "type": "string", + "enum": [ + "Actual", + "Forecasted" + ], + "x-ms-enum": { + "name": "ThresholdType", + "modelAsString": true, + "values": [ + { + "value": "Actual", + "description": "Actual costs budget alerts notify when the actual accrued cost exceeds the allocated budget.", + "name": "Actual" + }, + { + "value": "Forecasted", + "description": "Forecasted costs budget alerts provide advanced notification that your spending trends are likely to exceed your allocated budget, as it relies on forecasted cost predictions.", + "name": "Forecasted" + } + ] + }, + "default": "Actual" + }, + "locale": { + "description": "Language in which the recipient will receive the notification, \n\n Supported for CategoryType(s): Cost, ReservationUtilization.", + "type": "string", + "enum": [ + "en-us", + "ja-jp", + "zh-cn", + "de-de", + "es-es", + "fr-fr", + "it-it", + "ko-kr", + "pt-br", + "ru-ru", + "zh-tw", + "cs-cz", + "pl-pl", + "tr-tr", + "da-dk", + "en-gb", + "hu-hu", + "nb-no", + "nl-nl", + "pt-pt", + "sv-se" + ], + "x-ms-enum": { + "name": "CultureCode", + "modelAsString": true + } + } + }, + "required": [ + "enabled", + "operator", + "threshold", + "contactEmails" + ] + } + }, + "parameters": { + "scopeBudgetParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with budget operations.\n\n Supported scopes for **CategoryType: Cost**\n\n Azure RBAC Scopes:\n- '/subscriptions/{subscriptionId}/' for subscription scope\n- '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope\n- '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope\n\n EA (Enterprise Agreement) Scopes:\n\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope\n\n MCA (Modern Customer Agreement) Scopes:\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)\n\n Supported scopes for **CategoryType: ReservationUtilization**\n\n EA (Enterprise Agreement) Scopes:\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account Scope\n\nMCA (Modern Customer Agreement) Scopes:\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope (non-CSP only)\n- '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' for customer scope (CSP only)", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "budgetNameParameter": { + "name": "budgetName", + "in": "path", + "description": "Budget Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "^[a-zA-Z0-9_-]+$", + "minLength": 1, + "maxLength": 63 + }, + "budgetCategoryFilterParameter": { + "name": "$filter", + "description": "OData filter option. May be used to filter budgets by properties/category. The filter supports 'eq' only.", + "in": "query", + "required": false, + "type": "string" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json new file mode 100644 index 000000000000..477708474768 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json @@ -0,0 +1,799 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01-preview", + "title": "CostManagementClient" + }, + "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": { + "/{scope}/providers/Microsoft.CostManagement/exports": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_List", + "description": "The operation to list all exports at the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportsGetBySubscription": { + "$ref": "./examples/ExportsGetBySubscription.json" + }, + "ExportsGetByResourceGroup": { + "$ref": "./examples/ExportsGetByResourceGroup.json" + }, + "ExportsGetByBillingAccount": { + "$ref": "./examples/ExportsGetByBillingAccount.json" + }, + "ExportsGetByDepartment": { + "$ref": "./examples/ExportsGetByDepartment.json" + }, + "ExportsGetByEnrollmentAccount": { + "$ref": "./examples/ExportsGetByEnrollmentAccount.json" + }, + "ExportsGetByManagementGroup": { + "$ref": "./examples/ExportsGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last run of each export.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Get", + "description": "The operation to get the export for the defined scope by export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportGetBySubscription": { + "$ref": "./examples/ExportGetBySubscription.json" + }, + "ExportGetByResourceGroup": { + "$ref": "./examples/ExportGetByResourceGroup.json" + }, + "ExportGetByBillingAccount": { + "$ref": "./examples/ExportGetByBillingAccount.json" + }, + "ExportGetByDepartment": { + "$ref": "./examples/ExportGetByDepartment.json" + }, + "ExportGetByEnrollmentAccount": { + "$ref": "./examples/ExportGetByEnrollmentAccount.json" + }, + "ExportGetByManagementGroup": { + "$ref": "./examples/ExportGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last 10 runs of the export.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Exports" + ], + "operationId": "Exports_CreateOrUpdate", + "description": "The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportCreateOrUpdateBySubscription": { + "$ref": "./examples/ExportCreateOrUpdateBySubscription.json" + }, + "ExportCreateOrUpdateByResourceGroup": { + "$ref": "./examples/ExportCreateOrUpdateByResourceGroup.json" + }, + "ExportCreateOrUpdateByBillingAccount": { + "$ref": "./examples/ExportCreateOrUpdateByBillingAccount.json" + }, + "ExportCreateOrUpdateByDepartment": { + "$ref": "./examples/ExportCreateOrUpdateByDepartment.json" + }, + "ExportCreateOrUpdateByEnrollmentAccount": { + "$ref": "./examples/ExportCreateOrUpdateByEnrollmentAccount.json" + }, + "ExportCreateOrUpdateByManagementGroup": { + "$ref": "./examples/ExportCreateOrUpdateByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Export" + }, + "description": "Parameters supplied to the CreateOrUpdate Export operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Delete", + "description": "The operation to delete a export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportDeleteBySubscription": { + "$ref": "./examples/ExportDeleteBySubscription.json" + }, + "ExportDeleteByResourceGroup": { + "$ref": "./examples/ExportDeleteByResourceGroup.json" + }, + "ExportDeleteByBillingAccount": { + "$ref": "./examples/ExportDeleteByBillingAccount.json" + }, + "ExportDeleteByEnrollmentAccount": { + "$ref": "./examples/ExportDeleteByEnrollmentAccount.json" + }, + "ExportDeleteByDepartment": { + "$ref": "./examples/ExportDeleteByDepartment.json" + }, + "ExportDeleteByManagementGroup": { + "$ref": "./examples/ExportDeleteByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run": { + "post": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Execute", + "description": "The operation to run an export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportRunBySubscription": { + "$ref": "./examples/ExportRunBySubscription.json" + }, + "ExportRunByResourceGroup": { + "$ref": "./examples/ExportRunByResourceGroup.json" + }, + "ExportRunByBillingAccount": { + "$ref": "./examples/ExportRunByBillingAccount.json" + }, + "ExportRunByDepartment": { + "$ref": "./examples/ExportRunByDepartment.json" + }, + "ExportRunByEnrollmentAccount": { + "$ref": "./examples/ExportRunByEnrollmentAccount.json" + }, + "ExportRunByManagementGroup": { + "$ref": "./examples/ExportRunByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_GetExecutionHistory", + "description": "The operation to get the run history of an export for the defined scope and export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportRunHistoryGetBySubscription": { + "$ref": "./examples/ExportRunHistoryGetBySubscription.json" + }, + "ExportRunHistoryGetByResourceGroup": { + "$ref": "./examples/ExportRunHistoryGetByResourceGroup.json" + }, + "ExportRunHistoryGetByBillingAccount": { + "$ref": "./examples/ExportRunHistoryGetByBillingAccount.json" + }, + "ExportRunHistoryGetByDepartment": { + "$ref": "./examples/ExportRunHistoryGetByDepartment.json" + }, + "ExportRunHistoryGetByEnrollmentAccount": { + "$ref": "./examples/ExportRunHistoryGetByEnrollmentAccount.json" + }, + "ExportRunHistoryGetByManagementGroup": { + "$ref": "./examples/ExportRunHistoryGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeExportParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportExecutionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ExportListResult": { + "description": "Result of listing exports. It contains a list of available exports in the scope provided.", + "type": "object", + "properties": { + "value": { + "description": "The list of exports.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Export" + } + } + } + }, + "Export": { + "description": "An export resource.", + "type": "object", + "allOf": [ + { + "$ref": "common-types.json#/definitions/CostManagementProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportProperties", + "title": "Export properties" + } + } + }, + "ExportProperties": { + "description": "The properties of the export.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonExportProperties" + } + ], + "properties": { + "schedule": { + "description": "Has schedule information for the export.", + "$ref": "#/definitions/ExportSchedule" + } + } + }, + "CommonExportProperties": { + "description": "The common properties of the export.", + "type": "object", + "properties": { + "format": { + "description": "The format of the export being delivered. Currently only 'Csv' is supported.", + "type": "string", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "FormatType", + "modelAsString": true + } + }, + "deliveryInfo": { + "description": "Has delivery information for the export.", + "$ref": "#/definitions/ExportDeliveryInfo" + }, + "definition": { + "description": "Has the definition for the export.", + "$ref": "#/definitions/ExportDefinition" + }, + "runHistory": { + "description": "If requested, has the most recent run history for the export.", + "$ref": "#/definitions/ExportExecutionListResult" + }, + "partitionData": { + "description": "If set to true, exported data will be partitioned by size and placed in a blob directory together with a manifest file. Note: this option is currently available only for Microsoft Customer Agreement commerce scopes.", + "type": "boolean" + }, + "nextRunTimeEstimate": { + "description": "If the export has an active schedule, provides an estimate of the next run time.", + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "deliveryInfo", + "definition" + ] + }, + "ExportSchedule": { + "description": "The schedule associated with the export.", + "type": "object", + "properties": { + "status": { + "description": "The status of the export's schedule. If 'Inactive', the export's schedule is paused.", + "type": "string", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "StatusType", + "modelAsString": true + } + }, + "recurrence": { + "description": "The schedule recurrence.", + "type": "string", + "enum": [ + "Daily", + "Weekly", + "Monthly", + "Annually" + ], + "x-ms-enum": { + "name": "RecurrenceType", + "modelAsString": true + } + }, + "recurrencePeriod": { + "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.", + "$ref": "#/definitions/ExportRecurrencePeriod" + } + } + }, + "ExportDeliveryInfo": { + "description": "The delivery information associated with a export.", + "type": "object", + "properties": { + "destination": { + "description": "Has destination for the export being delivered.", + "$ref": "#/definitions/ExportDeliveryDestination" + } + }, + "required": [ + "destination" + ] + }, + "ExportRecurrencePeriod": { + "description": "The start and end date for recurrence schedule.", + "type": "object", + "properties": { + "from": { + "description": "The start date of recurrence.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date of recurrence.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from" + ] + }, + "ExportDeliveryDestination": { + "description": "This represents the blob storage account location where exports of costs will be delivered. There are two ways to configure the destination. The approach recommended for most customers is to specify the resourceId of the storage account. This requires a one-time registration of the account's subscription with the Microsoft.CostManagementExports resource provider in order to give Cost Management services access to the storage. When creating an export in the Azure portal this registration is performed automatically but API users may need to register the subscription explicitly (for more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services ). Another way to configure the destination is available ONLY to Partners with a Microsoft Partner Agreement plan who are global admins of their billing account. These Partners, instead of specifying the resourceId of a storage account, can specify the storage account name along with a SAS token for the account. This allows exports of costs to a storage account in any tenant. The SAS token should be created for the blob service with Service/Container/Object resource types and with Read/Write/Delete/List/Add/Create permissions (for more information see https://docs.microsoft.com/en-us/azure/cost-management-billing/costs/export-cost-data-storage-account-sas-key ).", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource id of the storage account where exports will be delivered. This is not required if a sasToken and storageAccount are specified.", + "type": "string" + }, + "container": { + "description": "The name of the container where exports will be uploaded. If the container does not exist it will be created.", + "type": "string" + }, + "rootFolderPath": { + "description": "The name of the directory where exports will be uploaded.", + "type": "string" + }, + "sasToken": { + "description": "A SAS token for the storage account. For a restricted set of Azure customers this together with storageAccount can be specified instead of resourceId. Note: the value returned by the API for this property will always be obfuscated. Returning this same obfuscated value will not result in the SAS token being updated. To update this value a new SAS token must be specified.", + "type": "string", + "x-ms-secret": true + }, + "storageAccount": { + "description": "The storage account where exports will be uploaded. For a restricted set of Azure customers this together with sasToken can be specified instead of resourceId.", + "type": "string" + } + }, + "required": [ + "container" + ] + }, + "ExportDefinition": { + "description": "The definition of an export.", + "type": "object", + "properties": { + "type": { + "description": "The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ExportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the export. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "MonthToDate", + "BillingMonthToDate", + "TheLastMonth", + "TheLastBillingMonth", + "WeekToDate", + "Custom" + ], + "x-ms-enum": { + "name": "TimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the export.", + "$ref": "#/definitions/ExportTimePeriod" + }, + "dataSet": { + "description": "The definition for data in the export.", + "$ref": "#/definitions/ExportDataset" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "ExportDataset": { + "description": "The definition for data in the export.", + "type": "object", + "properties": { + "granularity": { + "description": "The granularity of rows in the export. Currently only 'Daily' is supported.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "The export dataset configuration.", + "$ref": "#/definitions/ExportDatasetConfiguration" + } + } + }, + "ExportDatasetConfiguration": { + "description": "The export dataset configuration. Allows columns to be selected for the export. If not provided then the export will include all available columns.", + "type": "object", + "properties": { + "columns": { + "description": "Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples).", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ExportTimePeriod": { + "description": "The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months.", + "type": "object", + "properties": { + "from": { + "description": "The start date for export data.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date for export data.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ExportExecutionListResult": { + "description": "Result of listing the run history of an export.", + "type": "object", + "properties": { + "value": { + "description": "A list of export runs.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExportRun" + } + } + } + }, + "ExportRun": { + "description": "An export run.", + "type": "object", + "allOf": [ + { + "$ref": "common-types.json#/definitions/CostManagementProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportRunProperties", + "title": "Export run properties" + } + } + }, + "ExportRunProperties": { + "description": "The properties of the export run.", + "type": "object", + "properties": { + "executionType": { + "description": "The type of the export run.", + "type": "string", + "enum": [ + "OnDemand", + "Scheduled" + ], + "x-ms-enum": { + "name": "ExecutionType", + "modelAsString": true + } + }, + "status": { + "description": "The last known status of the export run.", + "type": "string", + "enum": [ + "Queued", + "InProgress", + "Completed", + "Failed", + "Timeout", + "NewDataNotAvailable", + "DataNotAvailable" + ], + "x-ms-enum": { + "name": "ExecutionStatus", + "modelAsString": true + } + }, + "submittedBy": { + "description": "The identifier for the entity that triggered the export. For on-demand runs it is the user email. For scheduled runs it is 'System'.", + "type": "string" + }, + "submittedTime": { + "description": "The time when export was queued to be run.", + "type": "string", + "format": "date-time" + }, + "processingStartTime": { + "description": "The time when export was picked up to be run.", + "type": "string", + "format": "date-time" + }, + "processingEndTime": { + "description": "The time when the export run finished.", + "type": "string", + "format": "date-time" + }, + "fileName": { + "description": "The name of the exported file.", + "type": "string" + }, + "runSettings": { + "description": "The export settings that were in effect for this run.", + "$ref": "#/definitions/CommonExportProperties" + }, + "error": { + "description": "The details of any error.", + "$ref": "common-types.json#/definitions/ErrorDetails" + } + } + } + }, + "parameters": { + "scopeExportParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "exportNameParameter": { + "name": "exportName", + "in": "path", + "description": "Export Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatecostdetailsreport.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatecostdetailsreport.json new file mode 100644 index 000000000000..41ac703a12cb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatecostdetailsreport.json @@ -0,0 +1,402 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01-preview", + "title": "CostManagementClient" + }, + "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": { + "/{scope}/providers/Microsoft.CostManagement/generateCostDetailsReport": { + "post": { + "tags": [ + "CostDetails" + ], + "operationId": "GenerateCostDetailsReport_CreateOperation", + "description": "This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "GenerateCostDetailsReportByBillingProfileAndInvoiceId": { + "$ref": "./examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json" + }, + "GenerateCostDetailsReportBySubscriptionAndTimePeriod": { + "$ref": "./examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json" + }, + "GenerateCostDetailsReportByCustomerAndTimePeriod": { + "$ref": "./examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json" + }, + "GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId": { + "$ref": "./examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json" + }, + "GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod": { + "$ref": "./examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json" + }, + "GenerateCostDetailsReportByDepartmentsAndTimePeriod": { + "$ref": "./examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json" + }, + "GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod": { + "$ref": "./examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateCostDetailsReportRequestDefinition" + }, + "description": "Parameters supplied to the Create cost details operation." + } + ], + "responses": { + "200": { + "description": "Request processing completed.", + "schema": { + "$ref": "#/definitions/CostDetailsOperationResults" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the Location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the result of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GenerateCostDetailsReportErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/costDetailsOperationResults/{operationId}": { + "get": { + "tags": [ + "CostDetails" + ], + "operationId": "GenerateCostDetailsReport_GetOperationResults", + "description": "Get the result of the specified operation. This link is provided in the CostDetails creation request response Location header.", + "x-ms-examples": { + "Get details of the operation result": { + "$ref": "./examples/CostDetailsOperationResultsBySubscriptionScope.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The target operation Id." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CostDetailsOperationResults" + } + }, + "202": { + "description": "Accepted. The operation is ongoing." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "GenerateCostDetailsReportErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 400 Bad Request - Invalid Request Payload. Request payload provided is not in a json format or had an invalid member not accepted in the request payload. \n\n * 400 Bad Request - Invalid request payload: can only have either timePeriod or invoiceId or billingPeriod. API only allows data to be pulled for either timePeriod or invoiceId or billingPeriod. Customer should provide only one of these parameters. \n\n * 400 Bad Request - Start date must be after . API only allows data to be pulled no older than 13 months from now. \n\n * 400 Bad Request - The maximum allowed date range is 1 months. API only allows data to be pulled for 1 month or less. \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "common-types.json#/definitions/ErrorDetails" + } + } + }, + "GenerateCostDetailsReportRequestDefinition": { + "description": "The definition of a cost detailed report.", + "type": "object", + "properties": { + "metric": { + "description": "The type of the detailed report. By default ActualCost is provided", + "type": "string", + "enum": [ + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "CostDetailsMetricType", + "modelAsString": true, + "values": [ + { + "value": "ActualCost", + "description": "Actual cost data.", + "name": "ActualCostCostDetailsMetricType" + }, + { + "value": "AmortizedCost", + "description": "Amortized cost data.", + "name": "AmortizedCostCostDetailsMetricType" + } + ] + } + }, + "timePeriod": { + "description": "The specific date range of cost details requested for the report. This parameter cannot be used alongside either the invoiceId or billingPeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost. API only allows data to be pulled for 1 month or less and no older than 13 months. If no timePeriod or billingPeriod or invoiceId is provided the API defaults to the open month time period", + "$ref": "#/definitions/CostDetailsTimePeriod" + }, + "billingPeriod": { + "description": "This parameter can be used only by Enterprise Agreement customers. Use the YearMonth(e.g. 202008) format. This parameter cannot be used alongside either the invoiceId or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost.", + "type": "string" + }, + "invoiceId": { + "description": "This parameter can only be used by Microsoft Customer Agreement customers. Additionally, it can only be used at the Billing Profile or Customer scope. This parameter cannot be used alongside either the billingPeriod or timePeriod parameters. If a timePeriod, invoiceId or billingPeriod parameter is not provided in the request body the API will return the current month's cost.", + "type": "string" + } + } + }, + "CostDetailsTimePeriod": { + "description": "The start and end date for pulling data for the cost detailed report. API only allows data to be pulled for 1 month or less and no older than 13 months.", + "type": "object", + "properties": { + "start": { + "description": "The start date to pull data from. example format 2020-03-15", + "type": "string" + }, + "end": { + "description": "The end date to pull data to. example format 2020-03-15", + "type": "string" + } + }, + "required": [ + "start", + "end" + ] + }, + "CostDetailsOperationResults": { + "description": "The result of the long running operation for cost details Api.", + "type": "object", + "properties": { + "id": { + "description": "The id of the long running operation.", + "type": "string" + }, + "name": { + "description": "The name of the long running operation.", + "type": "string" + }, + "type": { + "description": "The type of the long running operation.", + "type": "string" + }, + "status": { + "description": "The status of the cost details operation", + "type": "string", + "enum": [ + "Completed", + "NoDataFound", + "Failed" + ], + "x-ms-enum": { + "name": "CostDetailsStatusType", + "modelAsString": true, + "values": [ + { + "value": "Completed", + "description": "Operation is Completed.", + "name": "CompletedCostDetailsStatusType" + }, + { + "value": "NoDataFound", + "description": "Operation is Completed and no cost data found.", + "name": "NoDataFoundCostDetailsStatusType" + }, + { + "value": "Failed", + "description": "Operation Failed.", + "name": "FailedCostDetailsStatusType" + } + ] + } + }, + "manifest": { + "x-ms-client-flatten": true, + "description": "The manifest of the report generated by the operation.", + "$ref": "#/definitions/ReportManifest" + }, + "validTill": { + "description": "The time at which report URL becomes invalid/expires in UTC e.g. 2020-12-08T05:55:59.4394737Z.", + "type": "string", + "format": "date-time" + }, + "error": { + "description": "The details of the error.", + "$ref": "common-types.json#/definitions/ErrorDetails" + } + } + }, + "ReportManifest": { + "description": "The manifest of the report generated by the operation.", + "type": "object", + "properties": { + "manifestVersion": { + "description": "The Manifest version.", + "type": "string" + }, + "dataFormat": { + "description": "The data format of the report", + "type": "string", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "CostDetailsDataFormat", + "modelAsString": true, + "values": [ + { + "value": "Csv", + "description": "Csv data format.", + "name": "CsvCostDetailsDataFormat" + } + ] + } + }, + "byteCount": { + "description": "The total number of bytes in all blobs.", + "format": "int64", + "type": "integer" + }, + "blobCount": { + "description": "The total number of blobs.", + "format": "int32", + "type": "integer" + }, + "compressData": { + "description": "Is the data in compressed format.", + "type": "boolean" + }, + "requestContext": { + "x-ms-client-flatten": true, + "description": "The context of the Cost Details request.", + "$ref": "#/definitions/RequestContext" + }, + "blobs": { + "description": "List of blob information generated by this operation.", + "type": "array", + "items": { + "$ref": "#/definitions/BlobInfo" + }, + "x-ms-identifiers": [ + "blobLink" + ] + } + } + }, + "RequestContext": { + "description": "The context of the Cost Details request.", + "type": "object", + "properties": { + "requestScope": { + "description": "The request scope of the request.", + "type": "string" + }, + "requestBody": { + "description": "The request payload body provided in Cost Details call", + "$ref": "#/definitions/GenerateCostDetailsReportRequestDefinition" + } + } + }, + "BlobInfo": { + "description": "The blob information generated by this operation.", + "type": "object", + "properties": { + "blobLink": { + "description": "Link to the blob to download file.", + "type": "string" + }, + "byteCount": { + "description": "Bytes in the blob.", + "format": "int64", + "type": "integer" + } + } + } + }, + "parameters": { + "scopeUsageDetailsParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json new file mode 100644 index 000000000000..2edfbe7ebca7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json @@ -0,0 +1,368 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01-preview", + "title": "CostManagementClient" + }, + "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": { + "/{scope}/providers/Microsoft.CostManagement/generateDetailedCostReport": { + "post": { + "tags": [ + "UsageDetails" + ], + "operationId": "GenerateDetailedCostReport_CreateOperation", + "description": "Generates the detailed cost report for provided date range, billing period(only enterprise customers) or Invoice ID asynchronously at a certain scope. Call returns a 202 with header Azure-Consumption-AsyncOperation providing a link to the operation created. A call on the operation will provide the status and if the operation is completed the blob file where generated detailed cost report is being stored.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "GenerateDetailedCostReportByBillingProfileAndInvoiceId": { + "$ref": "./examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json" + }, + "GenerateDetailedCostReportBySubscriptionAndTimePeriod": { + "$ref": "./examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json" + }, + "GenerateDetailedCostReportByCustomerAndTimePeriod": { + "$ref": "./examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json" + }, + "GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId": { + "$ref": "./examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json" + }, + "GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod": { + "$ref": "./examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenerateDetailedCostReportDefinition" + }, + "description": "Parameters supplied to the Create detailed cost report operation." + } + ], + "responses": { + "200": { + "description": "Request processing completed.", + "schema": { + "$ref": "#/definitions/GenerateDetailedCostReportOperationResult" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the Location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the result of the asynchronous operation.", + "type": "string" + }, + "Azure-Consumption-AsyncOperation": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/GenerateDetailedCostReportErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/operationResults/{operationId}": { + "get": { + "tags": [ + "GenerateDetailedCostReportOperationResults" + ], + "operationId": "GenerateDetailedCostReportOperationResults_Get", + "description": "Gets the result of the specified operation. The link with this operationId is provided as a response header of the initial request.", + "x-ms-examples": { + "Get details of the operation result": { + "$ref": "./examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The target operation Id." + }, + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/GenerateDetailedCostReportOperationResult" + } + }, + "202": { + "description": "Accepted. The operation is ongoing." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/operationStatus/{operationId}": { + "get": { + "tags": [ + "GenerateDetailedCostReportOperationStatus" + ], + "operationId": "GenerateDetailedCostReportOperationStatus_Get", + "description": "Get the status of the specified operation. This link is provided in the GenerateDetailedCostReport creation request response header.", + "x-ms-examples": { + "Get details of the operation status": { + "$ref": "./examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json" + } + }, + "parameters": [ + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The target operation Id." + }, + { + "$ref": "#/parameters/scopeUsageDetailsParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/GenerateDetailedCostReportOperationStatuses" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "GenerateDetailedCostReportErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 413 Request Entity Too Large - Request is throttled. The amount of data required to fulfill the request exceeds the maximum size permitted of 2Gb. Please utilize our Exports feature instead. \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "common-types.json#/definitions/ErrorDetails" + } + } + }, + "GenerateDetailedCostReportDefinition": { + "description": "The definition of a cost detailed report.", + "properties": { + "metric": { + "description": "The type of the detailed report. By default ActualCost is provided", + "type": "string", + "enum": [ + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "GenerateDetailedCostReportMetricType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the cost detailed report. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided.", + "$ref": "#/definitions/GenerateDetailedCostReportTimePeriod" + }, + "billingPeriod": { + "description": "Billing period in YearMonth(e.g. 202008) format. Only for legacy enterprise customers can use this. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided.", + "type": "string" + }, + "invoiceId": { + "description": "Invoice ID for Pay-as-you-go and Microsoft Customer Agreement scopes. Can only have one of either timePeriod or invoiceId or billingPeriod parameters. If none provided current month cost is provided.", + "type": "string" + }, + "customerId": { + "description": "Customer ID for Microsoft Customer Agreement scopes (Invoice Id is also required for this).", + "type": "string" + } + } + }, + "GenerateDetailedCostReportTimePeriod": { + "description": "The start and end date for pulling data for the cost detailed report.", + "properties": { + "start": { + "description": "The start date to pull data from. example format 2020-03-15", + "type": "string" + }, + "end": { + "description": "The end date to pull data to. example format 2020-03-15", + "type": "string" + } + }, + "required": [ + "start", + "end" + ] + }, + "GenerateDetailedCostReportOperationStatuses": { + "description": "The status of the long running operation for cost detailed report.", + "properties": { + "id": { + "description": "The ID of the long running operation.", + "type": "string" + }, + "name": { + "description": "The name of the long running operation.", + "type": "string" + }, + "status": { + "description": "The status of the long running operation.", + "$ref": "#/definitions/Status" + }, + "startTime": { + "description": "The startTime of the operation.", + "type": "string" + }, + "endTime": { + "description": "The endTime of the operation.", + "type": "string" + }, + "type": { + "description": "The type of the long running operation.", + "type": "string" + }, + "error": { + "description": "The details of the error.", + "$ref": "common-types.json#/definitions/ErrorDetails" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the usage file generated.", + "$ref": "common-types.json#/definitions/DownloadURL" + } + } + }, + "GenerateDetailedCostReportOperationResult": { + "description": "The result of the long running operation for cost detailed report.", + "properties": { + "id": { + "description": "The ARM resource id of the long running operation.", + "type": "string" + }, + "name": { + "description": "The name of the long running operation.", + "type": "string" + }, + "type": { + "description": "The type of the long running operation.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the resource generated.", + "$ref": "common-types.json#/definitions/DownloadURL" + } + } + }, + "Status": { + "description": "The status of the long running operation.", + "properties": { + "status": { + "description": "The status of the long running operation.", + "type": "string", + "enum": [ + "InProgress", + "Completed", + "Failed", + "Queued", + "NoDataFound", + "ReadyToDownload", + "TimedOut" + ], + "x-ms-enum": { + "name": "ReportOperationStatusType", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "scopeUsageDetailsParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The ARM Resource ID for subscription, resource group, billing account, or other billing scopes. For details, see https://aka.ms/costmgmt/scopes.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.json new file mode 100644 index 000000000000..121a92a639c7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.json @@ -0,0 +1,2979 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01-preview", + "title": "CostManagementClient" + }, + "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.CostManagement/views": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_List", + "description": "Lists all views by tenant and object.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "PrivateViewList": { + "$ref": "./examples/PrivateViewList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ViewListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/views": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_ListByScope", + "description": "Lists all views at the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupViewList": { + "$ref": "./examples/ViewListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ViewListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.CostManagement/views/{viewName}": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_Get", + "description": "Gets the view by view name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "PrivateView": { + "$ref": "./examples/PrivateView.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Views" + ], + "operationId": "Views_CreateOrUpdate", + "description": "The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "CreateOrUpdatePrivateView": { + "$ref": "./examples/PrivateViewCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/View" + }, + "description": "Parameters supplied to the CreateOrUpdate View operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Views" + ], + "operationId": "Views_Delete", + "description": "The operation to delete a view.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "DeletePrivateView": { + "$ref": "./examples/PrivateViewDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/views/{viewName}": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_GetByScope", + "description": "Gets the view for the defined scope by view name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupView": { + "$ref": "./examples/ViewByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Views" + ], + "operationId": "Views_CreateOrUpdateByScope", + "description": "The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupCreateOrUpdateView": { + "$ref": "./examples/ViewCreateOrUpdateByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/View" + }, + "description": "Parameters supplied to the CreateOrUpdate View operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Views" + ], + "operationId": "Views_DeleteByScope", + "description": "The operation to delete a view.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupDeleteView": { + "$ref": "./examples/ViewDeleteByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_List", + "description": "Lists the alerts for scope defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "BillingAccountAlerts": { + "$ref": "./examples/BillingAccountAlerts.json" + }, + "BillingProfileAlerts": { + "$ref": "./examples/BillingProfileAlerts.json" + }, + "InvoiceSectionAlerts": { + "$ref": "./examples/InvoiceSectionAlerts.json" + }, + "EnrollmentAccountAlerts": { + "$ref": "./examples/EnrollmentAccountAlerts.json" + }, + "DepartmentAlerts": { + "$ref": "./examples/DepartmentAlerts.json" + }, + "SubscriptionAlerts": { + "$ref": "./examples/SubscriptionAlerts.json" + }, + "ResourceGroupAlerts": { + "$ref": "./examples/ResourceGroupAlerts.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_Get", + "description": "Gets the alert for the scope by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SingleSubscriptionAlerts": { + "$ref": "./examples/SingleSubscriptionAlert.json" + }, + "SingleResourceGroupAlerts": { + "$ref": "./examples/SingleResourceGroupAlert.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_Dismiss", + "description": "Dismisses the specified alert", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "PatchSubscriptionAlerts": { + "$ref": "./examples/DismissSubscriptionAlerts.json" + }, + "PatchResourceGroupAlerts": { + "$ref": "./examples/DismissResourceGroupAlerts.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DismissAlertPayload" + }, + "description": "Parameters supplied to the Dismiss Alert operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_ListExternal", + "description": "Lists the Alerts for external cloud provider type defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountAlerts": { + "$ref": "./examples/ExternalBillingAccountAlerts.json" + }, + "ExternalSubscriptionAlerts": { + "$ref": "./examples/ExternalSubscriptionAlerts.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_Usage", + "description": "Lists the forecast charges for scope defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "BillingAccountForecast": { + "$ref": "./examples/BillingAccountForecast.json" + }, + "BillingProfileForecast": { + "$ref": "./examples/BillingProfileForecast.json" + }, + "InvoiceSectionForecast": { + "$ref": "./examples/InvoiceSectionForecast.json" + }, + "EnrollmentAccountForecast": { + "$ref": "./examples/EnrollmentAccountForecast.json" + }, + "DepartmentForecast": { + "$ref": "./examples/DepartmentForecast.json" + }, + "SubscriptionForecast": { + "$ref": "./examples/SubscriptionForecast.json" + }, + "ResourceGroupForecast": { + "$ref": "./examples/ResourceGroupForecast.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/scopeForecastParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForecastDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Forecast Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ForecastResult" + } + }, + "204": { + "description": "No Content. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_ExternalCloudProviderUsage", + "description": "Lists the forecast charges for external cloud provider type defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountForecast": { + "$ref": "./examples/ExternalBillingAccountForecast.json" + }, + "ExternalSubscriptionForecast": { + "$ref": "./examples/ExternalSubscriptionForecast.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForecastDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Forecast Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ForecastResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_List", + "description": "Lists the dimensions by the defined scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionDimensionsList-Legacy": { + "$ref": "./examples/SubscriptionDimensionsList.json" + }, + "ResourceGroupDimensionsList-Legacy": { + "$ref": "./examples/ResourceGroupDimensionsList.json" + }, + "ManagementGroupDimensionsList-Legacy": { + "$ref": "./examples/ManagementGroupDimensionsList.json" + }, + "ManagementGroupDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/ManagementGroupDimensionsListExpandAndTop.json" + }, + "ManagementGroupDimensionsListWithFilter-Legacy": { + "$ref": "./examples/ManagementGroupDimensionsListWithFilter.json" + }, + "DepartmentDimensionsList-Legacy": { + "$ref": "./examples/DepartmentDimensionsList.json" + }, + "DepartmentDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/DepartmentDimensionsListExpandAndTop.json" + }, + "DepartmentDimensionsListWithFilter-Legacy": { + "$ref": "./examples/DepartmentDimensionsListWithFilter.json" + }, + "EnrollmentAccountDimensionsList-Legacy": { + "$ref": "./examples/EnrollmentAccountDimensionsList.json" + }, + "EnrollmentAccountDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/EnrollmentAccountDimensionsListExpandAndTop.json" + }, + "EnrollmentAccountDimensionsListWithFilter-Legacy": { + "$ref": "./examples/EnrollmentAccountDimensionsListWithFilter.json" + }, + "BillingAccountDimensionsList-Legacy": { + "$ref": "./examples/BillingAccountDimensionsList.json" + }, + "BillingAccountDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/BillingAccountDimensionsListExpandAndTop.json" + }, + "BillingAccountDimensionsListWithFilter-Legacy": { + "$ref": "./examples/BillingAccountDimensionsListWithFilter.json" + }, + "BillingAccountDimensionsList-MCA": { + "$ref": "./examples/MCABillingAccountDimensionsList.json" + }, + "BillingAccountDimensionsListExpandAndTop-MCA": { + "$ref": "./examples/MCABillingAccountDimensionsListExpandAndTop.json" + }, + "BillingAccountDimensionsListWithFilter-MCA": { + "$ref": "./examples/MCABillingAccountDimensionsListWithFilter.json" + }, + "BillingProfileDimensionsList-MCA": { + "$ref": "./examples/MCABillingProfileDimensionsList.json" + }, + "BillingProfileDimensionsListExpandAndTop-MCA": { + "$ref": "./examples/MCABillingProfileDimensionsListExpandAndTop.json" + }, + "BillingProfileDimensionsListWithFilter-MCA": { + "$ref": "./examples/MCABillingProfileDimensionsListWithFilter.json" + }, + "InvoiceSectionDimensionsList-MCA": { + "$ref": "./examples/MCAInvoiceSectionDimensionsList.json" + }, + "InvoiceSectionDimensionsListExpandAndTop-MCA": { + "$ref": "./examples/MCAInvoiceSectionDimensionsListExpandAndTop.json" + }, + "InvoiceSectionDimensionsListWithFilter-MCA": { + "$ref": "./examples/MCAInvoiceSectionDimensionsListWithFilter.json" + }, + "CustomerDimensionsList-MCA": { + "$ref": "./examples/MCACustomerDimensionsList.json" + }, + "CustomerDimensionsListExpandAndTop-MCA": { + "$ref": "./examples/MCACustomerDimensionsListExpandAndTop.json" + }, + "CustomerDimensionsListWithFilter-MCA": { + "$ref": "./examples/MCACustomerDimensionsListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeDimensionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "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" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionsListResult" + } + }, + "204": { + "description": "No Content. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_ByExternalCloudProviderType", + "description": "Lists the dimensions by the external cloud provider type.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountDimensionList": { + "$ref": "./examples/ExternalBillingAccountsDimensions.json" + }, + "ExternalSubscriptionDimensionList": { + "$ref": "./examples/ExternalSubscriptionsDimensions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "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" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000, + "format": "int32" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_Usage", + "description": "Query the usage data for scope defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionQuery-Legacy": { + "$ref": "./examples/SubscriptionQuery.json" + }, + "SubscriptionQueryGrouping-Legacy": { + "$ref": "./examples/SubscriptionQueryGrouping.json" + }, + "ResourceGroupQuery-Legacy": { + "$ref": "./examples/ResourceGroupQuery.json" + }, + "ResourceGroupQueryGrouping-Legacy": { + "$ref": "./examples/ResourceGroupQueryGrouping.json" + }, + "BillingAccountQuery-Legacy": { + "$ref": "./examples/BillingAccountQuery.json" + }, + "BillingAccountQueryGrouping-Legacy": { + "$ref": "./examples/BillingAccountQueryGrouping.json" + }, + "EnrollmentAccountQuery-Legacy": { + "$ref": "./examples/EnrollmentAccountQuery.json" + }, + "EnrollmentAccountQueryGrouping-Legacy": { + "$ref": "./examples/EnrollmentAccountQueryGrouping.json" + }, + "DepartmentQuery-Legacy": { + "$ref": "./examples/DepartmentQuery.json" + }, + "DepartmentQueryGrouping-Legacy": { + "$ref": "./examples/DepartmentQueryGrouping.json" + }, + "ManagementGroupQuery-Legacy": { + "$ref": "./examples/ManagementGroupQuery.json" + }, + "ManagementGroupQueryGrouping-Legacy": { + "$ref": "./examples/ManagementGroupQueryGrouping.json" + }, + "BillingAccountQuery-MCA": { + "$ref": "./examples/MCABillingAccountQuery.json" + }, + "BillingAccountQueryGrouping-MCA": { + "$ref": "./examples/MCABillingAccountQueryGrouping.json" + }, + "BillingProfileQuery-MCA": { + "$ref": "./examples/MCABillingProfileQuery.json" + }, + "BillingProfileQueryGrouping-MCA": { + "$ref": "./examples/MCABillingProfileQueryGrouping.json" + }, + "InvoiceSectionQuery-MCA": { + "$ref": "./examples/MCAInvoiceSectionQuery.json" + }, + "InvoiceSectionQueryGrouping-MCA": { + "$ref": "./examples/MCAInvoiceSectionQueryGrouping.json" + }, + "CustomerQuery-MCA": { + "$ref": "./examples/MCACustomerQuery.json" + }, + "CustomerQueryGrouping-MCA": { + "$ref": "./examples/MCACustomerQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Query Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "204": { + "description": "No Content. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_UsageByExternalCloudProviderType", + "description": "Query the usage data for external cloud provider type defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountQueryList": { + "$ref": "./examples/ExternalBillingAccountsQuery.json" + }, + "ExternalSubscriptionsQuery": { + "$ref": "./examples/ExternalSubscriptionsQuery.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Query Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/providers/Microsoft.CostManagement/generateReservationDetailsReport": { + "post": { + "tags": [ + "ReservedInstances" + ], + "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", + "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ReservationDetails": { + "$ref": "./examples/GenerateReservationDetailsReportByBillingAccount.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/enrollmentIdParameter" + }, + { + "$ref": "#/parameters/startDateParameter" + }, + { + "$ref": "#/parameters/endDateParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request processing completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.CostManagement/generateReservationDetailsReport": { + "post": { + "tags": [ + "ReservedInstances" + ], + "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", + "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ReservationDetails": { + "$ref": "./examples/GenerateReservationDetailsReportByBillingProfile.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "common-types.json#/parameters/billingAccountIdParameter" + }, + { + "$ref": "common-types.json#/parameters/billingProfileIdParameter" + }, + { + "$ref": "#/parameters/startDateParameter" + }, + { + "$ref": "#/parameters/endDateParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request processing completed.", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "Accepted. Request will be processed. Use the Location header to check the status.", + "headers": { + "Location": { + "description": "The URL to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "ReportConfigDefinition": { + "description": "The definition of a report config.", + "type": "object", + "properties": { + "type": { + "description": "The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.", + "type": "string", + "enum": [ + "Usage" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "WeekToDate", + "MonthToDate", + "YearToDate", + "Custom" + ], + "x-ms-enum": { + "name": "ReportTimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the report.", + "$ref": "#/definitions/ReportConfigTimePeriod" + }, + "dataSet": { + "description": "Has definition for data in this report config.", + "$ref": "#/definitions/ReportConfigDataset" + }, + "includeMonetaryCommitment": { + "description": "If true, report includes monetary commitment.", + "type": "boolean" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "ReportConfigTimePeriod": { + "description": "The start and end date for pulling data for the report.", + "type": "object", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ReportConfigDataset": { + "description": "The definition of data present in the report.", + "type": "object", + "properties": { + "granularity": { + "description": "The granularity of rows in the report.", + "type": "string", + "enum": [ + "Daily", + "Monthly" + ], + "x-ms-enum": { + "name": "ReportGranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/ReportConfigDatasetConfiguration" + }, + "aggregation": { + "type": "object", + "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.", + "additionalProperties": { + "$ref": "#/definitions/ReportConfigAggregation" + }, + "x-ms-identifiers": [ + "name" + ], + "maxItems": 2 + }, + "grouping": { + "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigGrouping" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "maxItems": 2 + }, + "sorting": { + "description": "Array of order by expression to use in the report.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigSorting" + }, + "x-ms-identifiers": [] + }, + "filter": { + "description": "Has filter expression to use in the report.", + "$ref": "#/definitions/ReportConfigFilter" + } + } + }, + "ReportConfigDatasetConfiguration": { + "description": "The configuration of dataset in the report.", + "type": "object", + "properties": { + "columns": { + "description": "Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ReportConfigAggregation": { + "description": "The aggregation expression to be used in the report.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string" + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "ReportConfigSorting": { + "description": "The order by expression to be used in the report.", + "type": "object", + "properties": { + "direction": { + "description": "Direction of sort.", + "type": "string", + "enum": [ + "Ascending", + "Descending" + ], + "x-ms-enum": { + "name": "ReportConfigSortingType", + "modelAsString": true + } + }, + "name": { + "description": "The name of the column to sort.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "ReportConfigGrouping": { + "description": "The group by expression to be used in the report.", + "type": "object", + "properties": { + "type": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/ReportConfigColumnType" + }, + "name": { + "description": "The name of the column to group. This version supports subscription lowest possible grain.", + "type": "string" + } + }, + "required": [ + "type", + "name" + ] + }, + "ReportConfigFilter": { + "description": "The filter expression to be used in the report.", + "type": "object", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "dimensions": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/ReportConfigComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/ReportConfigComparisonExpression" + } + } + }, + "ReportConfigColumnType": { + "description": "The type of the column in the report.", + "type": "string", + "enum": [ + "TagKey", + "Dimension" + ], + "x-ms-enum": { + "name": "QueryColumnType", + "modelAsString": true, + "values": [ + { + "value": "TagKey", + "description": "The tag associated with the cost data." + }, + { + "value": "Dimension", + "description": "The dimension of cost data." + } + ] + } + }, + "ReportConfigComparisonExpression": { + "description": "The comparison expression to be used in the report.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In", + "Contains" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "ViewListResult": { + "description": "Result of listing views. It contains a list of available views.", + "type": "object", + "properties": { + "value": { + "description": "The list of views.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/View" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "View": { + "description": "States and configurations of Cost Analysis.", + "type": "object", + "allOf": [ + { + "$ref": "common-types.json#/definitions/CostManagementProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ViewProperties", + "title": "View properties" + } + } + }, + "ViewProperties": { + "type": "object", + "description": "The properties of the view.", + "properties": { + "displayName": { + "description": "User input name of the view. Required.", + "type": "string" + }, + "scope": { + "description": "Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.", + "type": "string" + }, + "createdOn": { + "description": "Date the user created this view.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "description": "Date when the user last modified this view.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "dateRange": { + "description": "Date range of the current view.", + "type": "string", + "readOnly": true + }, + "currency": { + "description": "Currency of the current view.", + "type": "string", + "readOnly": true + }, + "query": { + "description": "Query body configuration. Required.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReportConfigDefinition" + }, + "chart": { + "description": "Chart type of the main view in Cost Analysis. Required.", + "type": "string", + "enum": [ + "Area", + "Line", + "StackedColumn", + "GroupedColumn", + "Table" + ], + "x-ms-enum": { + "name": "ChartType", + "modelAsString": true + } + }, + "accumulated": { + "description": "Show costs accumulated over time.", + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "AccumulatedType", + "modelAsString": true + } + }, + "metric": { + "description": "Metric to use when displaying costs.", + "type": "string", + "enum": [ + "ActualCost", + "AmortizedCost", + "AHUB" + ], + "x-ms-enum": { + "name": "MetricType", + "modelAsString": true + } + }, + "kpis": { + "description": "List of KPIs to show in Cost Analysis UI.", + "type": "array", + "items": { + "$ref": "#/definitions/KpiProperties" + } + }, + "pivots": { + "description": "Configuration of 3 sub-views in the Cost Analysis UI.", + "type": "array", + "items": { + "$ref": "#/definitions/PivotProperties" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "KpiProperties": { + "description": "Each KPI must contain a 'type' and 'enabled' key.", + "type": "object", + "properties": { + "type": { + "description": "KPI type (Forecast, Budget).", + "type": "string", + "enum": [ + "Forecast", + "Budget" + ], + "x-ms-enum": { + "name": "KpiTypeType", + "modelAsString": true + } + }, + "id": { + "description": "ID of resource related to metric (budget).", + "type": "string" + }, + "enabled": { + "description": "show the KPI in the UI?", + "type": "boolean" + } + } + }, + "PivotProperties": { + "description": "Each pivot must contain a 'type' and 'name'.", + "type": "object", + "properties": { + "type": { + "description": "Data type to show in view.", + "type": "string", + "enum": [ + "Dimension", + "TagKey" + ], + "x-ms-enum": { + "name": "PivotTypeType", + "modelAsString": true + } + }, + "name": { + "description": "Data field to show in view.", + "type": "string" + } + } + }, + "CostManagementResource": { + "description": "The Resource model definition.", + "type": "object", + "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": { + "readOnly": true, + "type": "string", + "description": "Location of the resource." + }, + "sku": { + "readOnly": true, + "type": "string", + "description": "SKU of the resource." + }, + "eTag": { + "readOnly": true, + "type": "string", + "description": "ETag of the resource." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "DimensionsListResult": { + "description": "Result of listing dimensions. It contains a list of available dimensions.", + "type": "object", + "properties": { + "value": { + "description": "The list of dimensions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Dimension" + } + } + } + }, + "Dimension": { + "description": "List of Dimension.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CostManagementResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DimensionProperties", + "title": "Dimension properties" + } + } + }, + "DimensionProperties": { + "description": "Dimension properties.", + "type": "object", + "properties": { + "description": { + "description": "Dimension description.", + "type": "string", + "readOnly": true + }, + "filterEnabled": { + "description": "Filter enabled.", + "type": "boolean", + "readOnly": true + }, + "groupingEnabled": { + "description": "Grouping enabled.", + "type": "boolean", + "readOnly": true + }, + "data": { + "description": "Dimension data.", + "type": "array", + "items": { + "description": "Dimension data item.", + "type": "string", + "readOnly": true + } + }, + "total": { + "description": "Total number of data for the dimension.", + "format": "int32", + "type": "integer", + "readOnly": true + }, + "category": { + "description": "Dimension category.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "Usage start.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "usageEnd": { + "description": "Usage end.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "AlertsResult": { + "description": "Result of alerts.", + "type": "object", + "properties": { + "value": { + "description": "List of alerts.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "description": "URL to get the next set of alerts results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Alert": { + "description": "An individual alert.", + "type": "object", + "allOf": [ + { + "$ref": "common-types.json#/definitions/CostManagementProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AlertProperties", + "title": "Alert properties" + } + } + }, + "AlertProperties": { + "description": "Alert properties.", + "type": "object", + "properties": { + "definition": { + "description": "defines the type of alert", + "type": "object", + "properties": { + "type": { + "description": "type of alert", + "type": "string", + "enum": [ + "Budget", + "Invoice", + "Credit", + "Quota", + "General", + "xCloud", + "BudgetForecast" + ], + "x-ms-enum": { + "name": "AlertType", + "modelAsString": true + } + }, + "category": { + "description": "Alert category", + "type": "string", + "enum": [ + "Cost", + "Usage", + "Billing", + "System" + ], + "x-ms-enum": { + "name": "AlertCategory", + "modelAsString": true + } + }, + "criteria": { + "description": "Criteria that triggered alert", + "type": "string", + "enum": [ + "CostThresholdExceeded", + "UsageThresholdExceeded", + "CreditThresholdApproaching", + "CreditThresholdReached", + "QuotaThresholdApproaching", + "QuotaThresholdReached", + "MultiCurrency", + "ForecastCostThresholdExceeded", + "ForecastUsageThresholdExceeded", + "InvoiceDueDateApproaching", + "InvoiceDueDateReached", + "CrossCloudNewDataAvailable", + "CrossCloudCollectionError", + "GeneralThresholdError" + ], + "x-ms-enum": { + "name": "AlertCriteria", + "modelAsString": true + } + } + } + }, + "description": { + "description": "Alert description", + "type": "string" + }, + "source": { + "description": "Source of alert", + "type": "string", + "enum": [ + "Preset", + "User" + ], + "x-ms-enum": { + "name": "AlertSource", + "modelAsString": true + } + }, + "details": { + "description": "Alert details", + "type": "object", + "properties": { + "timeGrainType": { + "description": "Type of timegrain cadence", + "type": "string", + "enum": [ + "None", + "Monthly", + "Quarterly", + "Annually", + "BillingMonth", + "BillingQuarter", + "BillingAnnual" + ], + "x-ms-enum": { + "name": "AlertTimeGrainType", + "modelAsString": true + } + }, + "periodStartDate": { + "description": "datetime of periodStartDate", + "type": "string" + }, + "triggeredBy": { + "description": "notificationId that triggered this alert", + "type": "string" + }, + "resourceGroupFilter": { + "description": "array of resourceGroups to filter by", + "type": "array", + "items": {}, + "x-ms-identifiers": [] + }, + "resourceFilter": { + "description": "array of resources to filter by", + "type": "array", + "items": {}, + "x-ms-identifiers": [] + }, + "meterFilter": { + "description": "array of meters to filter by", + "type": "array", + "items": {}, + "x-ms-identifiers": [] + }, + "tagFilter": { + "description": "tags to filter by", + "type": "object", + "properties": {} + }, + "threshold": { + "description": "notification threshold percentage as a decimal which activated this alert", + "type": "number", + "format": "decimal" + }, + "operator": { + "description": "operator used to compare currentSpend with amount", + "type": "string", + "enum": [ + "None", + "EqualTo", + "GreaterThan", + "GreaterThanOrEqualTo", + "LessThan", + "LessThanOrEqualTo" + ], + "x-ms-enum": { + "name": "AlertOperator", + "modelAsString": true + } + }, + "amount": { + "description": "budget threshold amount", + "type": "number", + "format": "decimal" + }, + "unit": { + "description": "unit of currency being used", + "type": "string" + }, + "currentSpend": { + "description": "current spend", + "type": "number", + "format": "decimal" + }, + "contactEmails": { + "description": "list of emails to contact", + "type": "array", + "items": { + "type": "string" + } + }, + "contactGroups": { + "description": "list of action groups to broadcast to", + "type": "array", + "items": { + "type": "string" + } + }, + "contactRoles": { + "description": "list of contact roles", + "type": "array", + "items": { + "type": "string" + } + }, + "overridingAlert": { + "description": "overriding alert", + "type": "string" + }, + "departmentName": { + "description": "department name", + "type": "string" + }, + "companyName": { + "description": "company name", + "type": "string" + }, + "enrollmentNumber": { + "description": "enrollment number", + "type": "string" + }, + "enrollmentStartDate": { + "description": "datetime of enrollmentStartDate", + "type": "string" + }, + "enrollmentEndDate": { + "description": "datetime of enrollmentEndDate", + "type": "string" + }, + "invoicingThreshold": { + "description": "invoicing threshold", + "type": "number", + "format": "decimal" + } + } + }, + "costEntityId": { + "description": "related budget", + "type": "string" + }, + "status": { + "description": "alert status", + "type": "string", + "enum": [ + "None", + "Active", + "Overridden", + "Resolved", + "Dismissed" + ], + "x-ms-enum": { + "name": "AlertStatus", + "modelAsString": true + } + }, + "creationTime": { + "description": "dateTime in which alert was created", + "type": "string" + }, + "closeTime": { + "description": "dateTime in which alert was closed", + "type": "string" + }, + "modificationTime": { + "description": "dateTime in which alert was last modified", + "type": "string" + }, + "statusModificationUserName": { + "description": "User who last modified the alert", + "type": "string" + }, + "statusModificationTime": { + "description": "dateTime in which the alert status was last modified", + "type": "string" + } + } + }, + "DismissAlertPayload": { + "description": "The request payload to update an alert", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AlertProperties", + "title": "Alert properties" + } + } + }, + "ForecastResult": { + "description": "Result of forecast. It contains all columns listed under groupings and aggregation.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CostManagementResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ForecastProperties", + "title": "Forecast properties" + } + } + }, + "ForecastProperties": { + "description": "Forecast properties", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string" + }, + "columns": { + "description": "Array of columns", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastColumn" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "rows": { + "description": "Array of rows", + "type": "array", + "items": { + "type": "array", + "items": {}, + "x-ms-identifiers": [] + }, + "x-ms-identifiers": [] + } + } + }, + "ForecastColumn": { + "description": "Forecast column properties", + "type": "object", + "properties": { + "name": { + "description": "The name of column.", + "type": "string" + }, + "type": { + "description": "The type of column.", + "type": "string" + } + } + }, + "QueryResult": { + "description": "Result of query. It contains all columns listed under groupings and aggregation.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CostManagementResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/QueryProperties", + "title": "Query properties" + } + } + }, + "QueryProperties": { + "description": "Query properties", + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string" + }, + "columns": { + "description": "Array of columns", + "type": "array", + "items": { + "$ref": "#/definitions/QueryColumn" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "rows": { + "description": "Array of rows", + "type": "array", + "items": { + "type": "array", + "items": {}, + "x-ms-identifiers": [] + }, + "x-ms-identifiers": [] + } + } + }, + "QueryColumn": { + "description": "QueryColumn properties", + "type": "object", + "properties": { + "name": { + "description": "The name of column.", + "type": "string" + }, + "type": { + "description": "The type of column.", + "type": "string" + } + } + }, + "ForecastDefinition": { + "description": "The definition of a forecast.", + "type": "object", + "properties": { + "type": { + "description": "The type of the forecast.", + "$ref": "#/definitions/ForecastType" + }, + "timeframe": { + "description": "The time frame for pulling data for the forecast. If custom, then a specific time period must be provided.", + "$ref": "#/definitions/ForecastTimeframe" + }, + "timePeriod": { + "description": "Has time period for pulling data for the forecast.", + "$ref": "#/definitions/ForecastTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this forecast.", + "$ref": "#/definitions/ForecastDataset" + }, + "includeActualCost": { + "description": "A boolean determining if actualCost will be included.", + "type": "boolean" + }, + "includeFreshPartialCost": { + "description": "A boolean determining if FreshPartialCost will be included.", + "type": "boolean" + } + }, + "required": [ + "type", + "timeframe", + "dataset" + ] + }, + "ForecastType": { + "description": "The type of the forecast.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ForecastType", + "modelAsString": true + } + }, + "ForecastTimeframe": { + "description": "The time frame for pulling data for the forecast.", + "type": "string", + "enum": [ + "Custom" + ], + "x-ms-enum": { + "name": "ForecastTimeframe", + "modelAsString": true + } + }, + "ForecastTimePeriod": { + "description": "Has time period for pulling data for the forecast.", + "type": "object", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ForecastDataset": { + "description": "The definition of data present in the forecast.", + "type": "object", + "properties": { + "granularity": { + "description": "The granularity of rows in the forecast.", + "$ref": "#/definitions/GranularityType" + }, + "configuration": { + "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/ForecastDatasetConfiguration" + }, + "aggregation": { + "description": "Dictionary of aggregation expression to use in the forecast. The key of each item in the dictionary is the alias for the aggregated column. forecast can have up to 2 aggregation clauses.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ForecastAggregation" + }, + "maxItems": 2 + }, + "filter": { + "description": "Has filter expression to use in the forecast.", + "$ref": "#/definitions/ForecastFilter" + } + }, + "required": [ + "aggregation" + ] + }, + "GranularityType": { + "description": "The granularity of rows in the forecast.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "ForecastDatasetConfiguration": { + "description": "The configuration of dataset in the forecast.", + "type": "object", + "properties": { + "columns": { + "description": "Array of column names to be included in the forecast. Any valid forecast column name is allowed. If not provided, then forecast includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ForecastAggregation": { + "description": "The aggregation expression to be used in the forecast.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string", + "enum": [ + "PreTaxCostUSD", + "Cost", + "CostUSD", + "PreTaxCost" + ], + "x-ms-enum": { + "name": "FunctionName", + "modelAsString": true + } + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "ForecastFilter": { + "description": "The filter expression to be used in the export.", + "type": "object", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ForecastFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "dimensions": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/ForecastComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/ForecastComparisonExpression" + } + } + }, + "ForecastComparisonExpression": { + "description": "The comparison expression to be used in the forecast.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "ForecastOperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "QueryDefinition": { + "description": "The definition of a query.", + "type": "object", + "properties": { + "type": { + "description": "The type of the query.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ExportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the query. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "MonthToDate", + "BillingMonthToDate", + "TheLastMonth", + "TheLastBillingMonth", + "WeekToDate", + "Custom" + ], + "x-ms-enum": { + "name": "TimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the query.", + "$ref": "#/definitions/QueryTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this query.", + "$ref": "#/definitions/QueryDataset" + } + }, + "required": [ + "type", + "timeframe", + "dataset" + ] + }, + "QueryTimePeriod": { + "description": "The start and end date for pulling data for the query.", + "type": "object", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "QueryDataset": { + "description": "The definition of data present in the query.", + "type": "object", + "properties": { + "granularity": { + "description": "The granularity of rows in the query.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/QueryDatasetConfiguration" + }, + "aggregation": { + "type": "object", + "description": "Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses.", + "additionalProperties": { + "$ref": "#/definitions/QueryAggregation" + }, + "maxItems": 2 + }, + "grouping": { + "description": "Array of group by expression to use in the query. Query can have up to 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryGrouping" + }, + "x-ms-identifiers": [ + "name", + "type" + ], + "maxItems": 2 + }, + "filter": { + "description": "The filter expression to use in the query. Please reference our Query API REST documentation for how to properly format the filter.", + "$ref": "#/definitions/QueryFilter" + } + } + }, + "OperationStatus": { + "description": "The status of the long running operation.", + "type": "object", + "properties": { + "status": { + "description": "The status of the long running operation.", + "type": "string", + "enum": [ + "Running", + "Completed", + "Failed" + ], + "x-ms-enum": { + "name": "OperationStatusType", + "modelAsString": true + } + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the resource generated.", + "$ref": "#/definitions/ReportURL" + } + } + }, + "ReportURL": { + "description": "The URL to download the generated report.", + "type": "object", + "properties": { + "reportUrl": { + "description": "The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity", + "$ref": "#/definitions/ReservationReportSchema" + }, + "validUntil": { + "description": "The time at which report URL becomes invalid.", + "type": "string", + "format": "date-time" + } + } + }, + "QueryDatasetConfiguration": { + "description": "The configuration of dataset in the query.", + "type": "object", + "properties": { + "columns": { + "description": "Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "QueryAggregation": { + "description": "The aggregation expression to be used in the query.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string" + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "QueryGrouping": { + "description": "The group by expression to be used in the query.", + "type": "object", + "properties": { + "type": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/QueryColumnType" + }, + "name": { + "description": "The name of the column to group.", + "type": "string" + } + }, + "required": [ + "type", + "name" + ] + }, + "QueryFilter": { + "description": "The filter expression to be used in the export.", + "type": "object", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryFilter" + }, + "x-ms-identifiers": [], + "minItems": 2 + }, + "dimensions": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/QueryComparisonExpression" + }, + "tags": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/QueryComparisonExpression" + } + } + }, + "QueryColumnType": { + "description": "The type of the column in the export.", + "type": "string", + "enum": [ + "TagKey", + "Dimension" + ], + "x-ms-enum": { + "name": "QueryColumnType", + "modelAsString": true, + "values": [ + { + "value": "TagKey", + "description": "The tag associated with the cost data." + }, + { + "value": "Dimension", + "description": "The dimension of cost data." + } + ] + } + }, + "QueryComparisonExpression": { + "description": "The comparison expression to be used in the query.", + "type": "object", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "QueryOperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "ReservationReportSchema": { + "description": "The CSV file from the reportUrl blob link consists of reservation usage data with the following schema at daily granularity", + "type": "string", + "enum": [ + "InstanceFlexibilityGroup", + "InstanceFlexibilityRatio", + "InstanceId", + "Kind", + "ReservationId", + "ReservationOrderId", + "ReservedHours", + "SkuName", + "TotalReservedQuantity", + "UsageDate", + "UsedHours" + ], + "x-ms-enum": { + "name": "ReservationReportSchema", + "modelAsString": true + } + } + }, + "parameters": { + "viewNameParameter": { + "name": "viewName", + "in": "path", + "description": "View name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "scopeViewParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope.", + "x-ms-parameter-location": "method" + }, + "scopeDimensionParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with dimension operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeAlertParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeForecastParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with forecast operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeQueryParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with query and export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure Resource Group Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "startDateParameter": { + "name": "startDate", + "in": "query", + "description": "Start Date", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "endDateParameter": { + "name": "endDate", + "in": "query", + "description": "End Date", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "Enrollment ID (Legacy BillingAccount ID)", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "managementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "description": "ManagementGroup ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "departmentIdParameter": { + "name": "departmentId", + "in": "path", + "description": "Department ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountIdParameter": { + "name": "enrollmentAccountId", + "in": "path", + "description": "Enrollment Account ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "externalCloudProviderTypeParameter": { + "name": "externalCloudProviderType", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "externalSubscriptions", + "externalBillingAccounts" + ], + "x-ms-enum": { + "name": "externalCloudProviderType", + "modelAsString": true + }, + "description": "The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.", + "x-ms-parameter-location": "method" + }, + "externalCloudProviderIdParameter": { + "name": "externalCloudProviderId", + "in": "path", + "required": true, + "type": "string", + "description": "This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.", + "x-ms-parameter-location": "method" + }, + "alertIdParameter": { + "name": "alertId", + "in": "path", + "description": "Alert ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.pricesheets.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.pricesheets.json new file mode 100644 index 000000000000..2dc519969245 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.pricesheets.json @@ -0,0 +1,189 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01-preview", + "title": "CostManagementClient" + }, + "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.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/providers/Microsoft.CostManagement/pricesheets/default/download": { + "post": { + "tags": [ + "PriceSheets" + ], + "x-ms-examples": { + "PricesheetDownload": { + "$ref": "./examples/PricesheetDownload.json" + } + }, + "operationId": "PriceSheet_Download", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download the pricesheet for an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + }, + "OData-EntityId": { + "description": "The operation entity Id GUID.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "common-types.json#/definitions/DownloadURL" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/providers/Microsoft.CostManagement/pricesheets/default/download": { + "post": { + "tags": [ + "PriceSheets" + ], + "x-ms-examples": { + "PricesheetDownloadByBillingProfile": { + "$ref": "./examples/PricesheetDownloadByBillingProfile.json" + } + }, + "operationId": "PriceSheet_DownloadByBillingProfile", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download the current month's pricesheet for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.Due to Azure product growth, the Azure price sheet download experience in this preview version will be updated from a single csv file to a Zip file containing multiple csv files, each with max 200k records.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + }, + "OData-EntityId": { + "description": "The operation entity Id GUID.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "common-types.json#/definitions/DownloadURL" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "parameters": { + "billingAccountNameParameter": { + "name": "billingAccountName", + "in": "path", + "description": "The ID that uniquely identifies a billing account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+):([A-Za-z0-9]+(-[A-Za-z0-9]+)+)_[0-9]{4}-[0-9]{2}-[0-9]{2}" + }, + "billingProfileNameParameter": { + "name": "billingProfileName", + "in": "path", + "description": "The ID that uniquely identifies a billing profile.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "([A-Za-z0-9]+(-[A-Za-z0-9]+)+)" + }, + "invoiceNameParameter": { + "name": "invoiceName", + "in": "path", + "description": "The ID that uniquely identifies an invoice.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "pattern": "[A-Za-z0-9]+" + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitRecommendationsByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitRecommendationsByBillingAccount.json new file mode 100644 index 000000000000..cc3e90bd95e6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitRecommendationsByBillingAccount.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingScope": "providers/Microsoft.Billing/billingAccounts/123456", + "$expand": "properties/usage,properties/allRecommendationDetails", + "$filter": "properties/lookBackPeriod eq 'Last7Days' AND properties/term eq 'P1Y'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/benefitRecommendations/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/benefitRecommendations", + "kind": "SavingsPlan", + "properties": { + "firstConsumptionDate": "2022-10-18T00:00:00Z", + "lastConsumptionDate": "2022-10-25T00:00:00Z", + "lookBackPeriod": "Last7Days", + "totalHours": 168, + "usage": { + "usageGrain": "Hourly", + "charges": [ + 1.0, + 1.0, + 0.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 2.0, + 2.0, + 2.0, + 2.0 + ] + }, + "armSkuName": "Compute_Savings_Plan", + "term": "P1Y", + "commitmentGranularity": "Hourly", + "currencyCode": "USD", + "costWithoutBenefit": 218.267, + "scope": "Shared", + "recommendationDetails": { + "averageUtilizationPercentage": 99.330, + "coveragePercentage": 54.609, + "commitmentAmount": 0.164, + "overageCost": 144.841, + "benefitCost": 52.002, + "savingsAmount": 21.424, + "savingsPercentage": 9.815, + "totalCost": 196.843, + "wastageCost": 0.035 + }, + "allRecommendationDetails": { + "value": [ + { + "averageUtilizationPercentage": 99.330, + "coveragePercentage": 54.609, + "commitmentAmount": 0.164, + "overageCost": 144.841, + "benefitCost": 52.002, + "savingsAmount": 21.424, + "savingsPercentage": 9.815, + "totalCost": 196.843, + "wastageCost": 0.035 + }, + { + "averageUtilizationPercentage": 81.474, + "coveragePercentage": 56.748, + "commitmentAmount": 0.161, + "overageCost": 120.389, + "benefitCost": 83.754, + "savingsAmount": 14.124, + "savingsPercentage": 6.470, + "totalCost": 204.143, + "wastageCost": 0.100 + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json new file mode 100644 index 000000000000..8402e8252be4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-BillingAccount.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Daily" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/benefitUtilizationSummaries/88cccc88-8ccc-8c88-888c-88cc8c8c88c8_444d44dd-d4d4-4dd4-444d-4dd4444ddddd_20211117", + "kind": "SavingsPlan", + "name": "88cccc88-8ccc-8c88-888c-88cc8c8c88c8_444d44dd-d4d4-4dd4-444d-4dd4444ddddd_20211117", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 60, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/88cccc88-8ccc-8c88-888c-88cc8c8c88c8", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/88cccc88-8ccc-8c88-888c-88cc8c8c88c8/savingsPlans/444d44dd-d4d4-4dd4-444d-4dd4444ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 70, + "minUtilizationPercentage": 50, + "usageDate": "2022-10-17T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json new file mode 100644 index 000000000000..a37229e4f0f8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-BillingProfile.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "c0a00000-0e04-5ee3-000e-f0c6e00000ec:c0a00000-0e04-5ee3-000e-f0c6e00000ec", + "billingProfileId": "200e5e90-000e-4960-8dcd-8d00a02db000", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Daily" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/c0a00000-0e04-5ee3-000e-f0c6e00000ec:c0a00000-0e04-5ee3-000e-f0c6e00000ec/billingProfiles/200e5e90-000e-4960-8dcd-8d00a02db000/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json new file mode 100644 index 000000000000..1d65f88da468 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanId-Monthly.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "savingsPlanOrderId": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "savingsPlanId": "222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Monthly" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202111", + "kind": "SavingsPlan", + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202111", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + }, + { + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202112", + "kind": "SavingsPlan", + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_202112", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 80, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 90, + "minUtilizationPercentage": 70, + "usageDate": "2022-10-17T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json new file mode 100644 index 000000000000..9a2cb3f13936 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BenefitUtilizationSummaries/SavingsPlan-SavingsPlanOrderId-Daily.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "savingsPlanOrderId": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "filter": "properties/usageDate ge 2022-10-15 and properties/usageDate le 2022-10-18", + "grain": "Daily" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/providers/Microsoft.CostManagement/benefitUtilizationSummaries/66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "kind": "SavingsPlan", + "name": "66cccc66-6ccc-6c66-666c-66cc6c6c66c6_222d22dd-d2d2-2dd2-222d-2dd2222ddddd_20211116", + "type": "Microsoft.CostManagement/benefitUtilizationSummaries", + "properties": { + "armSkuName": "Compute_Savings_Plan", + "avgUtilizationPercentage": 90, + "benefitOrderId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6", + "benefitId": "/providers/Microsoft.BillingBenefits/savingsPlanOrders/66cccc66-6ccc-6c66-666c-66cc6c6c66c6/savingsPlans/222d22dd-d2d2-2dd2-222d-2dd2222ddddd", + "benefitType": "SavingsPlan", + "maxUtilizationPercentage": 100, + "minUtilizationPercentage": 80, + "usageDate": "2022-10-16T00:00:00Z" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountAlerts.json new file mode 100644 index 000000000000..852e03160b44 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsList.json new file mode 100644 index 000000000000..705e6446c321 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..b9b22234eaaf --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..bf0b22e18cf5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountDimensionsListWithFilter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountForecast.json new file mode 100644 index 000000000000..bbb97581c1cc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountForecast.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountQuery.json new file mode 100644 index 000000000000..e5d38bf364fd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "70664866", + "scope": "providers/Microsoft.Billing/billingAccounts/70664866", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountQueryGrouping.json new file mode 100644 index 000000000000..414497920127 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingAccountQueryGrouping.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "70664866", + "scope": "providers/Microsoft.Billing/billingAccounts/70664866", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingProfileAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingProfileAlerts.json new file mode 100644 index 000000000000..1da71481b1ba --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingProfileAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingProfileForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingProfileForecast.json new file mode 100644 index 000000000000..ece5fdee53e0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/BillingProfileForecast.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json new file mode 100644 index 000000000000..26d8d4715aac --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter.json new file mode 100644 index 000000000000..c3e3e715407e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json new file mode 100644 index 000000000000..a4a3a177b2ba --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule.json new file mode 100644 index 000000000000..dd414df0a5fb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservationIdFilter.json new file mode 100644 index 000000000000..2c0c875c0eff --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservationIdFilter.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservedResourceTypeFilter.json new file mode 100644 index 000000000000..65801ce4fab3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservedResourceTypeFilter.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule.json new file mode 100644 index 000000000000..44c2282c77c2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservationIdFilter.json new file mode 100644 index 000000000000..97df91ca0469 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservationIdFilter.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservedResourceTypeFilter.json new file mode 100644 index 000000000000..dc0b03da67e4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservedResourceTypeFilter.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule.json new file mode 100644 index 000000000000..a7c11d086e6b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "parameters": { + "eTag": "\"1d34d016a593709\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Delete/DeleteBudget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Delete/DeleteBudget.json new file mode 100644 index 000000000000..28c2306e3d9c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Delete/DeleteBudget.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Get/Cost/Get-Cost-Budget.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Get/Cost/Get-Cost-Budget.json new file mode 100644 index 000000000000..979a7ccfbc03 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Get/Cost/Get-Cost-Budget.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "budgetName": "TestBudget", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json new file mode 100644 index 000000000000..5b7c9a51cf5b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/Get/ReservationUtilization/Get-ReservationUtilization-AlertRule.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "KKKK-LLLL-MMM-NNN", + "budgetName": "TestAlertRule", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestAlertRule", + "name": "TestAlertRule", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservedResourceType", + "operator": "In", + "values": [ + "VirtualMachines", + "SqlDatabases", + "CosmosDb" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json new file mode 100644 index 000000000000..1de7e886e2f8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/BillingAccountBudgetsList-EA-CategoryTypeFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "$filter": "properties/category eq 'ReservationUtilization'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json new file mode 100644 index 000000000000..e231572e6993 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/BillingAccountBudgetsList-EA.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "properties": { + "category": "Cost", + "amount": 10000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 8000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestBudget2", + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "properties": { + "category": "Cost", + "amount": 15000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 12000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Weekly", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/DepartmentBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/DepartmentBudgetsList.json new file mode 100644 index 000000000000..58b1eb8c40d6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/DepartmentBudgetsList.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "departmentId": "789101", + "scope": "providers/Microsoft.Billing/billingAccounts/123456/departments/789101" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/departments/789101/providers/Microsoft.CostManagement/budgets/DepartmentBudget1", + "name": "DepartmentBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157e\"", + "properties": { + "category": "Cost", + "amount": 5000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 3000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/departments/789101/providers/Microsoft.CostManagement/budgets/DepartmentBudget2", + "name": "DepartmentBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 8000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 6000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_75_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 75, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json new file mode 100644 index 000000000000..016a27c344be --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/EA/EnrollmentAccountBudgetsList.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "enrollmentAccountId": "473845", + "scope": "providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845/providers/Microsoft.CostManagement/budgets/EnrollmentAccountBudget1", + "name": "EnrollmentAccountBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157e\"", + "properties": { + "category": "Cost", + "amount": 5000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 3000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/enrollmentAccounts/473845/providers/Microsoft.CostManagement/budgets/EnrollmentAccountBudget2", + "name": "EnrollmentAccountBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 8000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 6000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_75_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 75, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json new file mode 100644 index 000000000000..5ddc44431cf4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA-CategoryTypeFilter.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "$filter": "properties/category eq 'ReservationUtilization'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json new file mode 100644 index 000000000000..ce0be6a237ac --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingAccountBudgetsList-MCA.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "properties": { + "category": "Cost", + "amount": 10000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 8000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/providers/Microsoft.CostManagement/budgets/TestBudget2", + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "properties": { + "category": "Cost", + "amount": 15000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 12000.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/KKKK-LLLL-MMM-NNN/providers/Microsoft.CostManagement/budgets/TestRUAlert", + "name": "TestRUAlert", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json new file mode 100644 index 000000000000..8e6588d87995 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingProfileBudgetsList-CategoryTypeFilter.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "MYDEVTESTBP", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP", + "$filter": "properties/category eq 'ReservationUtilization'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 80, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingProfileBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingProfileBudgetsList.json new file mode 100644 index 000000000000..d311c3ec5a53 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/BillingProfileBudgetsList.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "MYDEVTESTBP", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "properties": { + "category": "Cost", + "amount": 200.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 30.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestBudget2", + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "properties": { + "category": "Cost", + "amount": 600.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 20.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 80, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json new file mode 100644 index 000000000000..7f827df0b78c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/CustomerBudgetsList-CategoryTypeFilter.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "$filter": "properties/category eq 'ReservationUtilization'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 80, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/CustomerBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/CustomerBudgetsList.json new file mode 100644 index 000000000000..98da0b4667af --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/CustomerBudgetsList.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "customerId": "000000-1111-2222-3333-444444444444", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "properties": { + "category": "Cost", + "amount": 200.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 30.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestBudget2", + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "properties": { + "category": "Cost", + "amount": 600.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 20.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert1", + "name": "TestRUAlert1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last30Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": {}, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 99, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/customers/000000-1111-2222-3333-444444444444/providers/Microsoft.CostManagement/budgets/TestRUAlert2", + "name": "TestRUAlert2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "ReservationUtilization", + "timeGrain": "Last7Days", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2025-04-01T00:00:00Z" + }, + "filter": { + "dimensions": { + "name": "ReservationId", + "operator": "In", + "values": [ + "00000000-0000-0000-0000-000000000000", + "00000000-0000-0000-0000-000000000001", + "00000000-0000-0000-0000-000000000002" + ] + } + }, + "notifications": { + "Actual_LessThan_99_Percent": { + "enabled": true, + "operator": "LessThan", + "threshold": 80, + "frequency": "Daily", + "locale": "en-us", + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json new file mode 100644 index 000000000000..73cb4e9440c7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/MCA/InvoiceSectionBudgetsList.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01", + "billingProfileId": "MYDEVTESTBP", + "invoiceSectionId": "AAAA-BBBB-CCC-DDD", + "scope": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157c\"", + "properties": { + "category": "Cost", + "amount": 20.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 5.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee:ffffffff-gggg-hhhh-iiii-jjjjjjjjjjjj_2023-04-01/billingProfiles/MYDEVTESTBP/invoiceSections/AAAA-BBBB-CCC-DDD/providers/Microsoft.CostManagement/budgets/TestBudget2", + "name": "TestBudget2", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157d\"", + "properties": { + "category": "Cost", + "amount": 60.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "currentSpend": { + "amount": 20.00, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_70_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 70, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json new file mode 100644 index 000000000000..8582a99bb95e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/ManagementGroupBudgetsList.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "MYDEVTESTMG", + "scope": "Microsoft.Management/managementGroups/MYDEVTESTMG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "Microsoft.Management/managementGroups/MYDEVTESTMG/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 10000.00, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 8000.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "managers@contoso.com" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 600.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_90_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 200.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_40_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 40, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json new file mode 100644 index 000000000000..01927d32361e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/ResourceGroupBudgetsList.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "resourceGroupName": "MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget0", + "name": "TestBudget0", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_90_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 200.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_40_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 40, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json new file mode 100644 index 000000000000..c1923ba1006c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/List/RBAC/SubscriptionBudgetsList.json @@ -0,0 +1,191 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 600.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget", + "name": "TestBudget", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 100.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] + }, + "currentSpend": { + "amount": 80.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_80_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 80, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_90_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 90, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/budgets/TestBudget1", + "name": "TestBudget1", + "type": "Microsoft.CostManagement/budgets", + "eTag": "\"1d34d012214157f\"", + "properties": { + "category": "Cost", + "amount": 200.65, + "timeGrain": "Monthly", + "timePeriod": { + "startDate": "2023-04-01T00:00:00Z", + "endDate": "2024-10-31T00:00:00Z" + }, + "filter": {}, + "currentSpend": { + "amount": 120.89, + "unit": "USD" + }, + "notifications": { + "Actual_GreaterThan_40_Percent": { + "enabled": true, + "operator": "GreaterThan", + "threshold": 40, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ] + }, + "Actual_GreaterThanOrEqualTo_60_Percent": { + "enabled": true, + "operator": "GreaterThanOrEqualTo", + "threshold": 60, + "contactEmails": [ + "johndoe@contoso.com", + "janesmith@contoso.com" + ], + "contactRoles": [ + "Contributor", + "Reader" + ], + "contactGroups": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + ], + "thresholdType": "Actual" + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/CostDetailsOperationResultsBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/CostDetailsOperationResultsBySubscriptionScope.json new file mode 100644 index 000000000000..89c953216a0e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/CostDetailsOperationResultsBySubscriptionScope.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "operationId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-04-01-preview", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000", + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01-preview", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentAlerts.json new file mode 100644 index 000000000000..3c5b55a7c596 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsList.json new file mode 100644 index 000000000000..bd7d31a66ada --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..a09681bbe79e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsListExpandAndTop.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "departmentId": "123", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsListWithFilter.json new file mode 100644 index 000000000000..491344f41949 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentDimensionsListWithFilter.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "departmentId": "123", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentForecast.json new file mode 100644 index 000000000000..2f3ddddf3749 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentForecast.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentQuery.json new file mode 100644 index 000000000000..4fc15982ee34 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "70664866", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentQueryGrouping.json new file mode 100644 index 000000000000..8f95a7a11ec8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DepartmentQueryGrouping.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "70664866", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DismissResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DismissResourceGroupAlerts.json new file mode 100644 index 000000000000..67590a0b456f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DismissResourceGroupAlerts.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "alertId": "22222222-2222-2222-2222-222222222222", + "parameters": { + "properties": { + "status": "Dismissed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Dismissed", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DismissSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DismissSubscriptionAlerts.json new file mode 100644 index 000000000000..a006bcdc5d87 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/DismissSubscriptionAlerts.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "alertId": "22222222-2222-2222-2222-222222222222", + "parameters": { + "properties": { + "status": "Dismissed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Dismissed", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountAlerts.json new file mode 100644 index 000000000000..234037ca1b6c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsList.json new file mode 100644 index 000000000000..4209462e2ac2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..eab7632c62b1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..43b84d65e763 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountForecast.json new file mode 100644 index 000000000000..078707559ae6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountForecast.json @@ -0,0 +1,121 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountQuery.json new file mode 100644 index 000000000000..594174fa175d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountQueryGrouping.json new file mode 100644 index 000000000000..5eef11502d77 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/EnrollmentAccountQueryGrouping.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByBillingAccount.json new file mode 100644 index 000000000000..3d5d7706232e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByBillingAccount.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByDepartment.json new file mode 100644 index 000000000000..d99bd4f28ac2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByDepartment.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByEnrollmentAccount.json new file mode 100644 index 000000000000..af2721588041 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByEnrollmentAccount.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByManagementGroup.json new file mode 100644 index 000000000000..41127b3baa44 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByManagementGroup.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByResourceGroup.json new file mode 100644 index 000000000000..93b38d0a5847 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateByResourceGroup.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateBySubscription.json new file mode 100644 index 000000000000..4e7003b4ef68 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportCreateOrUpdateBySubscription.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByBillingAccount.json new file mode 100644 index 000000000000..100646d2af88 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByBillingAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByDepartment.json new file mode 100644 index 000000000000..22524980652e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByDepartment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByEnrollmentAccount.json new file mode 100644 index 000000000000..2dbaa88c3765 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByEnrollmentAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByManagementGroup.json new file mode 100644 index 000000000000..aadd3e5d4923 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByManagementGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByResourceGroup.json new file mode 100644 index 000000000000..ee022d22a6ec --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteByResourceGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteBySubscription.json new file mode 100644 index 000000000000..63cdfb8312c9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportDeleteBySubscription.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByBillingAccount.json new file mode 100644 index 000000000000..d3c4418b7045 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByBillingAccount.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-05-01T00:00:00Z", + "to": "2020-05-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByDepartment.json new file mode 100644 index 000000000000..a47a23f7644c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByDepartment.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByEnrollmentAccount.json new file mode 100644 index 000000000000..3089e74acba5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByEnrollmentAccount.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2019-09-01T00:00:00Z", + "to": "2019-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByManagementGroup.json new file mode 100644 index 000000000000..cdbf2479dab8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByManagementGroup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2019-09-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "UsageDate", + "MeterId", + "InstanceId", + "ResourceLocation", + "UsageQuantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByResourceGroup.json new file mode 100644 index 000000000000..9240fd7f852a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetBySubscription.json new file mode 100644 index 000000000000..eb8142452d94 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportGetBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2019-06-01T00:00:00Z", + "to": "2019-07-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByBillingAccount.json new file mode 100644 index 000000000000..100646d2af88 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByBillingAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByDepartment.json new file mode 100644 index 000000000000..22524980652e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByDepartment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByEnrollmentAccount.json new file mode 100644 index 000000000000..2dbaa88c3765 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByEnrollmentAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByManagementGroup.json new file mode 100644 index 000000000000..aadd3e5d4923 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByManagementGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByResourceGroup.json new file mode 100644 index 000000000000..ee022d22a6ec --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunByResourceGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunBySubscription.json new file mode 100644 index 000000000000..63cdfb8312c9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunBySubscription.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByBillingAccount.json new file mode 100644 index 000000000000..c6e18e21b70d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByBillingAccount.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByDepartment.json new file mode 100644 index 000000000000..1e4ba6496264 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByDepartment.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByEnrollmentAccount.json new file mode 100644 index 000000000000..abd299d3402e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByEnrollmentAccount.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByManagementGroup.json new file mode 100644 index 000000000000..46b9efb2ec4f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByManagementGroup.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByResourceGroup.json new file mode 100644 index 000000000000..4d37b022f840 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetByResourceGroup.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetBySubscription.json new file mode 100644 index 000000000000..7a1b7f155315 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportRunHistoryGetBySubscription.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByBillingAccount.json new file mode 100644 index 000000000000..7d08b5c969ed --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByBillingAccount.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByDepartment.json new file mode 100644 index 000000000000..396dd1c0b965 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByDepartment.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByEnrollmentAccount.json new file mode 100644 index 000000000000..82a98d1af382 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByEnrollmentAccount.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByManagementGroup.json new file mode 100644 index 000000000000..ce05e96bd71b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByManagementGroup.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByResourceGroup.json new file mode 100644 index 000000000000..2e2a5e983376 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetByResourceGroup.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetBySubscription.json new file mode 100644 index 000000000000..0eab76ed66e6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExportsGetBySubscription.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountAlerts.json new file mode 100644 index 000000000000..b32919b30078 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountForecast.json new file mode 100644 index 000000000000..6024064224dd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountForecast.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 0.0, + "Forecast", + "USD" + ], + [ + 30.2572751438, + "Forecast", + "USD" + ], + [ + 0.076757602000000022, + "Forecast", + "USD" + ], + [ + 50.430964190400012, + "Forecast", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountsDimensions.json new file mode 100644 index 000000000000..4e375f04c4ef --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountsDimensions.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceType_2019-12-01_2019-12-31", + "name": "dimensions_ResourceType_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 0, + "category": "ResourceType", + "description": "Resource type", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceId_2019-12-01_2019-12-31", + "name": "dimensions_ResourceId_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 0, + "category": "ResourceId", + "description": "Resource ID", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountsQuery.json new file mode 100644 index 000000000000..f4a93b424e19 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalBillingAccountsQuery.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ServiceName", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 0.0, + "abc db", + "USD" + ], + [ + 30.2572751438, + "abc compute cloud", + "USD" + ], + [ + 0.076757602000000022, + "abc file system", + "USD" + ], + [ + 50.430964190400012, + "abc elasticache", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionAlerts.json new file mode 100644 index 000000000000..5ac2a9143e2b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionForecast.json new file mode 100644 index 000000000000..7d74bfe21051 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionForecast.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", + "name": "d99477af-7510-40ee-aca2-e59bdca0d10d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionsDimensions.json new file mode 100644 index 000000000000..98ed15b345a6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionsDimensions.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceType_2019-12-01_2019-12-31", + "name": "dimensions_ResourceType_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 0, + "category": "ResourceType", + "description": "Resource type", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceId_2019-12-01_2019-12-31", + "name": "dimensions_ResourceId_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 0, + "category": "ResourceId", + "description": "Resource ID", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionsQuery.json new file mode 100644 index 000000000000..7544339cfe20 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ExternalSubscriptionsQuery.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", + "name": "d99477af-7510-40ee-aca2-e59bdca0d10d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json new file mode 100644 index 000000000000..485b723a601c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingAccountEnterpriseAgreementCustomerAndBillingPeriod.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "providers/Microsoft.Billing/billingAccounts/12345", + "parameters": { + "metric": "ActualCost", + "billingPeriod": "202205" + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-04-01-preview", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345", + "requestBody": { + "metric": "ActualCost", + "billingPeriod": "202205" + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01-preview", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json new file mode 100644 index 000000000000..7448c4d54137 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceId.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "metric": "ActualCost", + "invoiceId": "M1234567" + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-04-01-preview", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "requestBody": { + "metric": "ActualCost", + "billingPeriod": "202205" + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01-preview", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json new file mode 100644 index 000000000000..fbc4febf25d9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByBillingProfileAndInvoiceIdAndCustomerId.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", + "parameters": { + "metric": "ActualCost", + "invoiceId": "M1234567" + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-04-01-preview", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", + "requestBody": { + "metric": "ActualCost", + "billingPeriod": "202205" + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01-preview", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json new file mode 100644 index 000000000000..6b31324a572f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByCustomerAndTimePeriod.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-04-01-preview", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01-preview", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json new file mode 100644 index 000000000000..1250a6ad4051 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByDepartmentsAndTimePeriod.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "providers/Microsoft.Billing/departments/12345", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-04-01-preview", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/departments/12345", + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/departments/12345/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01-preview", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json new file mode 100644 index 000000000000..216b82f89d44 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportByEnrollmentAccountsAndTimePeriod.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "providers/Microsoft.Billing/enrollmentAccounts/1234", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-04-01-preview", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "providers/Microsoft.Billing/enrollmentAccounts/1234", + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/enrollmentAccounts/1234/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01-preview", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json new file mode 100644 index 000000000000..13d9eeb50b49 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateCostDetailsReportBySubscriptionAndTimePeriod.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "manifest": { + "manifestVersion": "2023-04-01-preview", + "dataFormat": "Csv", + "blobCount": 1, + "byteCount": 32741, + "compressData": false, + "requestContext": { + "requestScope": "subscriptions/00000000-0000-0000-0000-000000000000", + "requestBody": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "blobs": [ + { + "blobLink": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/00000/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "byteCount": 32741 + } + ] + }, + "validTill": "2022-05-10T08:08:46.1973252Z" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/costDetailsOperationResults/00000000-0000-0000-0000-000000000000?api-version=2023-04-01-preview", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json new file mode 100644 index 000000000000..9ba12288e047 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingAccountLegacyAndBillingPeriod.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "providers/Microsoft.Billing/billingAccounts/12345", + "parameters": { + "metric": "ActualCost", + "billingPeriod": "202008" + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json new file mode 100644 index 000000000000..7ea58121fe4c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceId.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "metric": "ActualCost", + "invoiceId": "M1234567" + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json new file mode 100644 index 000000000000..87f2fff3c023 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByBillingProfileAndInvoiceIdAndCustomerId.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "metric": "ActualCost", + "invoiceId": "M1234567", + "customerId": "456789" + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json new file mode 100644 index 000000000000..b46963b73600 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportByCustomerAndTimePeriod.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/13579/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json new file mode 100644 index 000000000000..81a312cf6cf7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportBySubscriptionAndTimePeriod.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "metric": "ActualCost", + "timePeriod": { + "start": "2020-03-01", + "end": "2020-03-15" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json new file mode 100644 index 000000000000..4ad821fba442 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportOperationResultsBySubscriptionScope.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "operationId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationResults/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Consumption/operationResult", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationResults/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Azure-Consumption-AsyncOperation": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345/providers/Microsoft.CostManagement/operationStatus/ad0d632f-1186-41fe-89f9-ae29e198d223?api-version=2021-10-01", + "Retry-After": "60" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json new file mode 100644 index 000000000000..16fd79ebf724 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateDetailedCostReportOperationStatusBySubscriptionScope.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "operationId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/operationStatus/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "status": "Completed", + "type": "Microsoft.Consumption/operationStatus", + "properties": { + "downloadUrl": "https://ccmreportstorageeastus.blob.core.windows.net/armreports/20201207/00000000-0000-0000-0000-000000000000?sv=2020-05-31&sr=b&sig=abcd", + "validTill": "2020-12-08T05:55:59.4394737Z" + }, + "error": { + "code": 0, + "message": null + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json new file mode 100644 index 000000000000..274ebb4cbe7e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "billingAccountId": "9845612", + "startDate": "2020-01-01", + "endDate": "2020-01-30", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "status": "Completed", + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20200911/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2020-09-12T02:56:55.5021869Z" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json new file mode 100644 index 000000000000..4c2719d2ac9b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "billingAccountId": "00000000-0000-0000-0000-000000000000", + "billingProfileId": "CZSFR-SDFXC-DSDF", + "startDate": "2020-01-01", + "endDate": "2020-01-30", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "status": "Completed", + "properties": { + "reportUrl": "https://storage.blob.core.windows.net/details/20200911/00000000-0000-0000-0000-000000000000?sv=2016-05-31&sr=b&sig=jep8HT2aphfUkyERRZa5LRfd9RPzjXbzB%2F9TNiQ", + "validUntil": "2020-09-12T02:56:55.5021869Z" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/InvoiceSectionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/InvoiceSectionAlerts.json new file mode 100644 index 000000000000..0d831316c92e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/InvoiceSectionAlerts.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/InvoiceSectionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/InvoiceSectionForecast.json new file mode 100644 index 000000000000..832922a42881 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/InvoiceSectionForecast.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsList.json new file mode 100644 index 000000000000..a73d588386ca --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..4b84e1207f2e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..37fbe3940937 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountQuery.json new file mode 100644 index 000000000000..aa7ed434465e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountQueryGrouping.json new file mode 100644 index 000000000000..43f70db192ee --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingAccountQueryGrouping.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsList.json new file mode 100644 index 000000000000..8104f2a7b4a3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..17b1e170852d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json new file mode 100644 index 000000000000..155da4cf9c7d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileQuery.json new file mode 100644 index 000000000000..2bad2ed1c700 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileQueryGrouping.json new file mode 100644 index 000000000000..0bed18f37d8c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCABillingProfileQueryGrouping.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsList.json new file mode 100644 index 000000000000..c06a0b6b3c65 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..a4d7d20128fa --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "customerId": "5678", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsListWithFilter.json new file mode 100644 index 000000000000..627052d987c2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerDimensionsListWithFilter.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "customerId": "13579", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerQuery.json new file mode 100644 index 000000000000..f6974a3f8630 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerQueryGrouping.json new file mode 100644 index 000000000000..d5cad9c02aef --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCACustomerQueryGrouping.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsList.json new file mode 100644 index 000000000000..9e49cee09048 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsList.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..26d9c7a82989 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json new file mode 100644 index 000000000000..b34af8bb8a61 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionQuery.json new file mode 100644 index 000000000000..eb78c378b49f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionQuery.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionQueryGrouping.json new file mode 100644 index 000000000000..b98075f94d52 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/MCAInvoiceSectionQueryGrouping.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsList.json new file mode 100644 index 000000000000..81dfdf29cccc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..d1e1f12515ab --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "MyMgId", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsListWithFilter.json new file mode 100644 index 000000000000..d1baabf886d5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupDimensionsListWithFilter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "MyMgId", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupQuery.json new file mode 100644 index 000000000000..4a1eab531cc3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupQueryGrouping.json new file mode 100644 index 000000000000..0eee717f54c1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ManagementGroupQueryGrouping.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/OperationList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/OperationList.json new file mode 100644 index 000000000000..5419a2000e4e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/OperationList.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "Microsoft.CostManagement/budgets/read", + "name": "Microsoft.CostManagement/budgets/read", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Budgets", + "operation": "List budgets", + "description": "List the budgets by a subscription or a management group." + } + }, + { + "id": "Microsoft.CostManagement/query/action", + "name": "Microsoft.CostManagement/query/action", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Query", + "operation": "Query usage data", + "description": "Query usage data by a scope." + } + }, + { + "id": "Microsoft.CostManagement/exports/read", + "name": "Microsoft.CostManagement/exports/read", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Exports", + "operation": "List exports", + "description": "List the exports by scope." + } + }, + { + "id": "Microsoft.CostManagement/exports/write", + "name": "Microsoft.CostManagement/exports/write", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Exports", + "operation": "Create and update export", + "description": "Create or update the specified export." + } + }, + { + "id": "Microsoft.CostManagement/exports/action", + "name": "Microsoft.CostManagement/exports/action", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Exports", + "operation": "Run export", + "description": "Run the specified export." + } + }, + { + "id": "Microsoft.CostManagement/exports/run/action", + "name": "Microsoft.CostManagement/exports/run/action", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "exports/run", + "operation": "Run exports", + "description": "Run exports." + } + }, + { + "id": "Microsoft.CostManagement/alerts/read", + "name": "Microsoft.CostManagement/alerts/read", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Alerts", + "operation": "List Alerts", + "description": "List alerts." + } + }, + { + "id": "Microsoft.CostManagement/operations/read", + "name": "Microsoft.CostManagement/operations/read", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Operations", + "operation": "List supported operations", + "description": "List all supported operations by Microsoft.CostManagement resource provider." + } + }, + { + "id": "Microsoft.CostManagement/views/action", + "name": "Microsoft.CostManagement/views/action", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Views", + "operation": "Create views", + "description": "Create view." + } + }, + { + "id": "Microsoft.CostManagement/views/write", + "name": "Microsoft.CostManagement/views/write", + "display": { + "provider": "Microsoft.CostManagement", + "resource": "Views", + "operation": "Update views", + "description": "Update view." + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PricesheetDownload.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PricesheetDownload.json new file mode 100644 index 000000000000..1cd6c49a6078 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PricesheetDownload.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountName": "7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31", + "billingProfileName": "2USN-TPCD-BG7-TGB", + "invoiceName": "T000940677" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2023-04-01-preview&OperationType=PriceSheet", + "Retry-After": "60", + "OData-EntityId": "45000000-0000-0000-0000-000000000000" + } + }, + "200": { + "body": { + "downloadUrl": "https://myaccount.blob.core.windows.net/?restype=service&comp=properties&sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", + "expiryTime": "2022-09-30T17:32:28Z" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PricesheetDownloadByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PricesheetDownloadByBillingProfile.json new file mode 100644 index 000000000000..834c6e7736ed --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PricesheetDownloadByBillingProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "billingAccountName": "7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31", + "billingProfileName": "2USN-TPCD-BG7-TGB" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com:443/providers/Microsoft.Billing/billingAccounts/7c05a543-80ff-571e-9f98-1063b3b53cf2:99ad03ad-2d1b-4889-a452-090ad407d25f_2019-05-31/billingProfiles/2USN-TPCD-BG7-TGB/providers/Microsoft.CostManagement/operationResults/45000000-0000-0000-0000-000000000000?sessiontoken=0:000000&api-version=2023-04-01-preview&OperationType=PriceSheet", + "Retry-After": "60", + "OData-EntityId": "45000000-0000-0000-0000-000000000000" + } + }, + "200": { + "body": { + "downloadUrl": "https://myaccount.blob.core.windows.net/?restype=service&comp=properties&sv=2015-04-05&ss=bf&srt=s&st=2015-04-29T22%3A18%3A26Z&se=2015-04-30T02%3A23%3A26Z&sr=b&sp=rw&spr=https&sig=G%2TEST%4B", + "expiryTime": "2018-07-21T17:32:28Z" + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateView.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateView.json new file mode 100644 index 000000000000..6721240f1481 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateView.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "viewName": "swaggerExample" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewCreateOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewCreateOrUpdate.json new file mode 100644 index 000000000000..8a227b3b1ef7 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewCreateOrUpdate.json @@ -0,0 +1,185 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "viewName": "swaggerExample", + "parameters": { + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "200": { + "body": { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewDelete.json new file mode 100644 index 000000000000..064b6887c66c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewDelete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "viewName": "TestView" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewList.json new file mode 100644 index 000000000000..7f52fd54ad8a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/PrivateViewList.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + }, + { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample2", + "name": "swaggerExample2", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example 2", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "LastMonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "GroupedColumn", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupAlerts.json new file mode 100644 index 000000000000..6c31f298d9b2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupDimensionsList.json new file mode 100644 index 000000000000..d2a3df0e4cd8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupDimensionsList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "system.orlando", + "$expand": "properties/data", + "$top": 5, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.storage/storageaccounts" + ], + "total": 1, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/authprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/systemevents", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/armadminprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/publicsystemportal" + ], + "total": 27, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupForecast.json new file mode 100644 index 000000000000..8ef6202d020c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupForecast.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupQuery.json new file mode 100644 index 000000000000..d98cea49eaf3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupQuery.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180417, + "USD" + ], + [ + 20.10333307059661, + "ScreenSharingTest-peer", + 20180418, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupQueryGrouping.json new file mode 100644 index 000000000000..a0878eb26975 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ResourceGroupQueryGrouping.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceType" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceType", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "Microsoft.SqlServer", + 20180417, + "USD" + ], + [ + 20.10333307059661, + "Microsoft.Compute", + 20180418, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SingleResourceGroupAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SingleResourceGroupAlert.json new file mode 100644 index 000000000000..3e1e04f5381f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SingleResourceGroupAlert.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "alertId": "22222222-2222-2222-2222-222222222222" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SingleSubscriptionAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SingleSubscriptionAlert.json new file mode 100644 index 000000000000..8c850a3db7b3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SingleSubscriptionAlert.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "alertId": "22222222-2222-2222-2222-222222222222" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionAlerts.json new file mode 100644 index 000000000000..56941b14796f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionDimensionsList.json new file mode 100644 index 000000000000..9c1979e766ec --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionDimensionsList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$top": 5, + "$expand": "properties/data", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "dcrg", + "rg", + "offlinegalleryrg", + "system.orlando.adminkeyvault", + "system.orlando.keyvault" + ], + "total": 68, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.storage/storageaccounts", + "microsoft.web.admin/role", + "microsoft.sql/servers", + "microsoft.compute/virtualmachines" + ], + "total": 4, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionForecast.json new file mode 100644 index 000000000000..7dabf5cb33c8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionForecast.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "type": "Usage", + "timeframe": "Custom", + "timePeriod": { + "from": "2022-08-01T00:00:00+00:00", + "to": "2022-08-31T23:59:59+00:00" + }, + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "Cost", + "function": "Sum" + } + }, + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + 20180429, + "Forecast", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionQuery.json new file mode 100644 index 000000000000..63769d11f894 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimensions": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tags": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimensions": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180331, + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod", + 20180331, + "USD" + ], + [ + 0.14384913581657052, + "ssbciotelement01", + 20180401, + "USD" + ], + [ + 0.009865586851323632, + "ict_stratandplan_goldsprova_prod", + 20180429, + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionQueryGrouping.json new file mode 100644 index 000000000000..e57c12a55396 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/SubscriptionQueryGrouping.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 0.009865586851323632, + "Ict_StratAndPlan_GoldSprova_Prod_0", + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod_1", + "USD" + ], + [ + 2.10333307059661, + "ScreenSharingTest-peer1", + "USD" + ], + [ + 0.14384913581657052, + "Ssbciotelement01", + "USD" + ] + ] + } + } + }, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewByResourceGroup.json new file mode 100644 index 000000000000..2fcfda68fa65 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewByResourceGroup.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "viewName": "swaggerExample", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json new file mode 100644 index 000000000000..9cd842bb61a3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json @@ -0,0 +1,186 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "swaggerExample", + "parameters": { + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewDeleteByResourceGroup.json new file mode 100644 index 000000000000..ed5dcd36dcbc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewDeleteByResourceGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "TestView" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewListByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewListByResourceGroup.json new file mode 100644 index 000000000000..bf4f4e3d91dc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/ViewListByResourceGroup.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample2", + "name": "swaggerExample2", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example 2", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "LastMonthToDate", + "dataSet": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "GroupedColumn", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json new file mode 100644 index 000000000000..a7b2eedf5495 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/checkNameAvailability-private-scheduledAction.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "checkNameAvailabilityRequest": { + "name": "testName", + "type": "Microsoft.CostManagement/ScheduledActions" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "A private scheduled action with name 'testName' is already present. Please specify a differnt name." + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json new file mode 100644 index 000000000000..d297db8328b9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "checkNameAvailabilityRequest": { + "name": "testName", + "type": "Microsoft.CostManagement/ScheduledActions" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-createOrUpdate-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-createOrUpdate-private.json new file mode 100644 index 000000000000..f825da8a7823 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-createOrUpdate-private.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "name": "monthlyCostByResource", + "If-Match": "", + "scheduledAction": { + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "language": "fr", + "regionalFormat": "fr", + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "language": "fr", + "regionalFormat": "fr", + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "scope": "", + "status": "Enabled", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json new file mode 100644 index 000000000000..9815926d0c78 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-createOrUpdate-shared.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "name": "monthlyCostByResource", + "If-Match": "", + "scheduledAction": { + "kind": "Email", + "properties": { + "displayName": "Monthly Cost By Resource", + "fileDestination": { + "fileFormats": [ + "Csv" + ] + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "fileDestination": { + "fileFormats": [ + "Csv" + ] + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-delete-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-delete-private.json new file mode 100644 index 000000000000..f36819f952a9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-delete-private.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "name": "monthlyCostByResource" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-delete-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-delete-shared.json new file mode 100644 index 000000000000..d8b1f0597683 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-delete-shared.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "name": "monthlyCostByResource" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-get-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-get-private.json new file mode 100644 index 000000000000..7edbd10086a0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-get-private.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "name": "monthlyCostByResource" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-get-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-get-shared.json new file mode 100644 index 000000000000..bbd3707387bb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-get-shared.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "name": "monthlyCostByResource" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json new file mode 100644 index 000000000000..c457cd762262 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "name": "dailyAnomalyByResource", + "If-Match": "", + "scheduledAction": { + "kind": "InsightAlert", + "properties": { + "displayName": "Daily anomaly by resource", + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost anomaly detected in the resource" + }, + "schedule": { + "frequency": "Daily", + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource", + "name": "dailyAnomalyByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "InsightAlert", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily anomaly by resource", + "fileDestination": { + "fileFormats": [] + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost anomaly detected in the resource" + }, + "schedule": { + "frequency": "Daily", + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyAnomalyByResource", + "name": "dailyAnomalyByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "InsightAlert", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily anomaly by resource", + "fileDestination": { + "fileFormats": [] + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost anomaly detected in the resource" + }, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "schedule": { + "frequency": "Daily", + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-sendNow-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-sendNow-private.json new file mode 100644 index 000000000000..b3636aaa02a4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-sendNow-private.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "name": "monthlyCostByResource" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-sendNow-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-sendNow-shared.json new file mode 100644 index 000000000000..499f2b51a7dd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledAction-sendNow-shared.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "name": "monthlyCostByResource" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-list-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-list-private.json new file mode 100644 index 000000000000..b7cec52be4f6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-list-private.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + }, + { + "id": "providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d15\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily Cost By Resource", + "scope": "", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Daily Cost By Resource" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-list-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-list-shared.json new file mode 100644 index 000000000000..445d5e4dd3b1 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-list-shared.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d15\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Daily Cost By Resource" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-listWithFilter-private.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-listWithFilter-private.json new file mode 100644 index 000000000000..d2cb2132ffc6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-listWithFilter-private.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "$filter": "properties/viewId eq '/providers/Microsoft.CostManagement/views/swaggerExample'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + }, + { + "id": "providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d15\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily Cost By Resource", + "scope": "", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Daily Cost By Resource" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-listWithFilter-shared.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-listWithFilter-shared.json new file mode 100644 index 000000000000..fb574e2ede9b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/scheduledActions/scheduledActions-listWithFilter-shared.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "$filter": "properties/viewId eq '/providers/Microsoft.CostManagement/views/swaggerExample'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/monthlyCostByResource", + "name": "monthlyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d10\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Monthly Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Monthly", + "weeksOfMonth": [ + "First", + "Third" + ], + "daysOfWeek": [ + "Monday" + ], + "hourOfDay": 10, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Cost by resource this month" + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/scheduledActions/dailyCostByResource", + "name": "dailyCostByResource", + "type": "Microsoft.CostManagement/ScheduledActions", + "kind": "Email", + "eTag": "\"1d4ff9fe66f1d15\"", + "systemData": { + "createdBy": "testuser", + "createdByType": "User", + "createdAt": "2020-06-18T22:21:51.1287144Z", + "lastModifiedBy": "testuser", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-18T22:21:51.1287144Z" + }, + "properties": { + "displayName": "Daily Cost By Resource", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Disabled", + "viewId": "/providers/Microsoft.CostManagement/views/swaggerExample", + "schedule": { + "frequency": "Daily", + "hourOfDay": 12, + "startDate": "2020-06-19T22:21:51.1287144Z", + "endDate": "2021-06-19T22:21:51.1287144Z" + }, + "notification": { + "to": [ + "user@gmail.com", + "team@gmail.com" + ], + "subject": "Daily Cost By Resource" + } + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/scheduledActions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/scheduledActions.json new file mode 100644 index 000000000000..7a35872d9d53 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/scheduledActions.json @@ -0,0 +1,931 @@ +{ + "swagger": "2.0", + "info": { + "title": "CostManagementClient", + "version": "2023-04-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": { + "/providers/Microsoft.CostManagement/scheduledActions": { + "get": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_List", + "description": "List all private scheduled actions.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "PrivateScheduledActionsList": { + "$ref": "./examples/scheduledActions/scheduledActions-list-private.json" + }, + "PrivateScheduledActionsListFilterByViewId": { + "$ref": "./examples/scheduledActions/scheduledActions-listWithFilter-private.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledActionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/scheduledActions": { + "get": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_ListByScope", + "description": "List all shared scheduled actions within the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "ScheduledActionsListByScope": { + "$ref": "./examples/scheduledActions/scheduledActions-list-shared.json" + }, + "ScheduledActionsListByScopeFilterByViewId": { + "$ref": "./examples/scheduledActions/scheduledActions-listWithFilter-shared.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter scheduled actions by properties/viewId. Supported operator is 'eq'.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledActionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.CostManagement/scheduledActions/{name}": { + "put": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_CreateOrUpdate", + "description": "Create or update a private scheduled action.", + "x-ms-examples": { + "CreateOrUpdatePrivateScheduledAction": { + "$ref": "./examples/scheduledActions/scheduledAction-createOrUpdate-private.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "scheduledAction", + "description": "Scheduled action to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + { + "$ref": "#/parameters/IfMatchOptionalParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + }, + "get": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_Get", + "description": "Get the private scheduled action by name.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "PrivateScheduledAction": { + "$ref": "./examples/scheduledActions/scheduledAction-get-private.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + }, + "delete": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_Delete", + "description": "Delete a private scheduled action.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "PrivateScheduledActionDelete": { + "$ref": "./examples/scheduledActions/scheduledAction-delete-private.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}": { + "put": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_CreateOrUpdateByScope", + "description": "Create or update a shared scheduled action within the given scope.", + "x-ms-examples": { + "CreateOrUpdateScheduledActionByScope": { + "$ref": "./examples/scheduledActions/scheduledAction-createOrUpdate-shared.json" + }, + "CreateOrUpdateInsightAlertScheduledActionByScope": { + "$ref": "./examples/scheduledActions/scheduledAction-insightAlert-createOrUpdate-shared.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "scheduledAction", + "description": "Scheduled action to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + { + "$ref": "#/parameters/IfMatchOptionalParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + }, + "get": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_GetByScope", + "description": "Get the shared scheduled action from the given scope by name.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "ScheduledActionByScope": { + "$ref": "./examples/scheduledActions/scheduledAction-get-shared.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + }, + "delete": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_DeleteByScope", + "description": "Delete a scheduled action within the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/cost-management/" + }, + "x-ms-examples": { + "ScheduledActionDeleteByScope": { + "$ref": "./examples/scheduledActions/scheduledAction-delete-shared.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/scheduledActions/{name}/execute": { + "post": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_Run", + "description": "Processes a private scheduled action.", + "x-ms-examples": { + "ScheduledActionSendNow": { + "$ref": "./examples/scheduledActions/scheduledAction-sendNow-private.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded. It might take up to an hour to receive the email." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/scheduledActions/{name}/execute": { + "post": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_RunByScope", + "description": "Runs a shared scheduled action within the given scope.", + "x-ms-examples": { + "ScheduledActionRunByScope": { + "$ref": "./examples/scheduledActions/scheduledAction-sendNow-shared.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/scheduledActionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded. It might take up to an hour to receive cost analysis information." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/checkNameAvailability": { + "post": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_CheckNameAvailability", + "description": "Checks availability and correctness of the name for a scheduled action.", + "x-ms-examples": { + "ScheduledActionCheckNameAvailability": { + "$ref": "./examples/scheduledActions/checkNameAvailability-private-scheduledAction.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityRequest", + "description": "Scheduled action to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Response of scheduled action name availability.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/checkNameAvailability": { + "post": { + "tags": [ + "ScheduledActions" + ], + "operationId": "ScheduledActions_CheckNameAvailabilityByScope", + "description": "Checks availability and correctness of the name for a scheduled action within the given scope.", + "x-ms-examples": { + "ScheduledActionCheckNameAvailabilityByScope": { + "$ref": "./examples/scheduledActions/checkNameAvailability-shared-scheduledAction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityRequest", + "description": "Scheduled action to be created or updated.", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "Response of scheduled action name availability.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "common-types.json#/definitions/ErrorResponseWithNestedDetails" + } + } + } + } + } + }, + "definitions": { + "DaysOfWeek": { + "type": "string", + "description": "Days of Week.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "x-ms-enum": { + "name": "DaysOfWeek", + "modelAsString": true + } + }, + "FileDestination": { + "type": "object", + "description": "Destination of the view data. This is optional. Currently only CSV format is supported.", + "properties": { + "fileFormats": { + "type": "array", + "description": "Destination of the view data. Currently only CSV format is supported.", + "items": { + "$ref": "#/definitions/FileFormat" + } + } + } + }, + "FileFormat": { + "type": "string", + "description": "Destination of the view data. Currently only CSV format is supported.", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "FileFormat", + "modelAsString": true + } + }, + "Language": { + "type": "string", + "description": "Language in which the email is localized, for ex: 'Fr'. When the specified language is not supported, email will be in english. The supported languages are cs (Czech), da (Danish), de (German), en (English), es (Spanish), fr (French), hu (Hungarian), id (Indonesian), it (Lithuanian), ja (Japanese), ko (Korean), nb (Norwegian Bokmål), nl (Dutch), pl (Polish), pt (Portuguese), ru (Russian), sv (Swedish), tr (Turkish), zh (Chinese) " + }, + "NotificationEmail": { + "type": "string", + "description": "Email address of the point of contact that should get the unsubscribe requests and notification emails." + }, + "NotificationProperties": { + "type": "object", + "description": "The properties of the scheduled action notification.", + "required": [ + "to", + "subject" + ], + "properties": { + "to": { + "description": "Array of email addresses.", + "type": "array", + "items": { + "type": "string", + "pattern": "^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\\.)+[A-Za-z]{2,}$" + }, + "minItems": 1, + "maxItems": 20 + }, + "language": { + "description": "Locale of the email.", + "$ref": "#/definitions/Language" + }, + "message": { + "description": "Optional message to be added in the email. Length is limited to 250 characters.", + "type": "string" + }, + "regionalFormat": { + "description": "Regional format used for formatting date/time and currency values in the email.", + "$ref": "#/definitions/RegionalFormat" + }, + "subject": { + "description": "Subject of the email. Length is limited to 70 characters.", + "type": "string" + } + } + }, + "RegionalFormat": { + "type": "string", + "description": "Language for formatting the date/time and currency values in the email. For ex: 'fr'. Defaulted to English, when the specified regional format is not supported. " + }, + "ScheduledActionProxyResource": { + "description": "The Resource model definition.", + "properties": { + "eTag": { + "type": "string", + "readOnly": true, + "description": "Resource Etag. For update calls, eTag is mandatory. Fetch the resource's eTag by doing a 'GET' call first and then including the latest eTag as part of the request body or 'If-Match' header while performing the update. For create calls, eTag is not required." + }, + "kind": { + "$ref": "#/definitions/ScheduledActionKind", + "description": "Kind of the scheduled action." + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "Kind of the scheduled action." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "type": "object", + "x-ms-azure-resource": true + }, + "ScheduledAction": { + "description": "Scheduled action definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduledActionProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduledActionProperties", + "title": "Scheduled action properties" + } + } + }, + "ScheduledActionKind": { + "type": "string", + "description": "Kind of the scheduled action.", + "enum": [ + "Email", + "InsightAlert" + ], + "x-ms-enum": { + "name": "ScheduledActionKind", + "modelAsString": true, + "values": [ + { + "value": "Email", + "description": "Cost analysis data will be emailed.", + "name": "Email" + }, + { + "value": "InsightAlert", + "description": "Cost anomaly information will be emailed. Available only on subscription scope at daily frequency. If no anomaly is detected on the resource, an email won't be sent.", + "name": "InsightAlert" + } + ] + } + }, + "ScheduledActionListResult": { + "description": "Scheduled actions list result. It contains a list of scheduled actions.", + "type": "object", + "properties": { + "value": { + "description": "The list of scheduled actions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ScheduledAction" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ScheduledActionProperties": { + "type": "object", + "description": "The properties of the scheduled action.", + "required": [ + "displayName", + "notification", + "schedule", + "status", + "viewId" + ], + "properties": { + "displayName": { + "description": "Scheduled action name.", + "type": "string" + }, + "fileDestination": { + "description": "Destination format of the view data. This is optional.", + "$ref": "#/definitions/FileDestination" + }, + "notification": { + "description": "Notification properties based on scheduled action kind.", + "$ref": "#/definitions/NotificationProperties" + }, + "notificationEmail": { + "description": "Email address of the point of contact that should get the unsubscribe requests and notification emails.", + "$ref": "#/definitions/NotificationEmail" + }, + "schedule": { + "description": "Schedule of the scheduled action.", + "$ref": "#/definitions/ScheduleProperties" + }, + "scope": { + "description": "Cost Management scope like 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/ScheduledActionStatus", + "description": "Status of the scheduled action." + }, + "viewId": { + "description": "Cost analysis viewId used for scheduled action. For example, '/providers/Microsoft.CostManagement/views/swaggerExample'", + "type": "string" + } + } + }, + "ScheduledActionStatus": { + "type": "string", + "description": "Status of the scheduled action.", + "enum": [ + "Enabled", + "Expired", + "Disabled" + ], + "x-ms-enum": { + "name": "ScheduledActionStatus", + "modelAsString": true, + "values": [ + { + "value": "Disabled", + "description": "Scheduled action is saved but will not be run.", + "name": "Disabled" + }, + { + "value": "Enabled", + "description": "Scheduled action is saved and will be run.", + "name": "Enabled" + }, + { + "value": "Expired", + "description": "Scheduled action is expired.", + "name": "Expired" + } + ] + } + }, + "ScheduleFrequency": { + "type": "string", + "description": "Frequency of the schedule.", + "enum": [ + "Daily", + "Weekly", + "Monthly" + ], + "x-ms-enum": { + "name": "ScheduleFrequency", + "modelAsString": true, + "values": [ + { + "value": "Daily", + "description": "Cost analysis data will be emailed every day.", + "name": "Daily" + }, + { + "value": "Weekly", + "description": "Cost analysis data will be emailed every week.", + "name": "Weekly" + }, + { + "value": "Monthly", + "description": "Cost analysis data will be emailed every month.", + "name": "Monthly" + } + ] + } + }, + "ScheduleProperties": { + "type": "object", + "description": "The properties of the schedule.", + "required": [ + "endDate", + "frequency", + "startDate" + ], + "properties": { + "frequency": { + "$ref": "#/definitions/ScheduleFrequency", + "description": "Frequency of the schedule." + }, + "hourOfDay": { + "type": "integer", + "description": "UTC time at which cost analysis data will be emailed.", + "format": "int32" + }, + "daysOfWeek": { + "description": "Day names in english on which cost analysis data will be emailed. This property is applicable when frequency is Weekly or Monthly.", + "type": "array", + "items": { + "$ref": "#/definitions/DaysOfWeek" + } + }, + "weeksOfMonth": { + "description": "Weeks in which cost analysis data will be emailed. This property is applicable when frequency is Monthly and used in combination with daysOfWeek.", + "type": "array", + "items": { + "$ref": "#/definitions/WeeksOfMonth" + } + }, + "dayOfMonth": { + "type": "integer", + "description": "UTC day on which cost analysis data will be emailed. Must be between 1 and 31. This property is applicable when frequency is Monthly and overrides weeksOfMonth or daysOfWeek.", + "format": "int32" + }, + "startDate": { + "description": "The start date and time of the scheduled action (UTC).", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The end date and time of the scheduled action (UTC).", + "type": "string", + "format": "date-time" + } + } + }, + "WeeksOfMonth": { + "type": "string", + "description": "Weeks of month.", + "enum": [ + "First", + "Second", + "Third", + "Fourth", + "Last" + ], + "x-ms-enum": { + "name": "WeeksOfMonth", + "modelAsString": true + } + } + }, + "parameters": { + "scopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with scheduled action operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope. Note: Insight Alerts are only available on subscription scope.", + "x-ms-parameter-location": "method" + }, + "scheduledActionNameParameter": { + "name": "name", + "in": "path", + "description": "Scheduled action name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "IfMatchOptionalParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "description": "ETag of the Entity. Not required when creating an entity, but required when updating an entity.", + "type": "string" + } + } +} diff --git a/specification/cost-management/resource-manager/readme.go.md b/specification/cost-management/resource-manager/readme.go.md index 9080ee0734fd..d750fdc293c0 100644 --- a/specification/cost-management/resource-manager/readme.go.md +++ b/specification/cost-management/resource-manager/readme.go.md @@ -36,6 +36,11 @@ directive: - $.definitions.ExportRun.allOf[0] transform: > $['$ref'] = "common-types.json#/definitions/ProxyResourceForCostManagement"; +- from: costmanagement.budgets.json + where: + - $.definitions.Budget.allOf[0] + transform: > + $['$ref'] = "common-types.json#/definitions/ProxyResourceForCostManagement"; - rename-model: from: 'CostManagementResource' to: 'ResourceForCostManagement' diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index 4dddb6da306a..5eb6de73b3f7 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -32,11 +32,28 @@ azure-validator: false --- + +### Tag: package-preview-2023-04 + +These settings apply only when `--tag=package-preview-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-04' +input-file: + - Microsoft.CostManagement/preview/2023-04-01-preview/common-types.json + - Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.benefits.json + - Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json + - Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.exports.json + - Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatecostdetailsreport.json + - Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.generatedetailedcostreport.json + - Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.json + - Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.pricesheets.json + - Microsoft.CostManagement/preview/2023-04-01-preview/scheduledActions.json +``` ### Tag: package-2022-10 These settings apply only when `--tag=package-2022-10` is specified on the command line. -```yaml $(tag) == 'package-2022-10' +``` yaml $(tag) == 'package-2022-10' input-file: - Microsoft.CostManagement/stable/2022-10-01/common-types.json - Microsoft.CostManagement/stable/2022-10-01/costmanagement.json @@ -52,7 +69,7 @@ input-file: These settings apply only when `--tag=package-preview-2022-10-05` is specified on the command line. -```yaml $(tag) == 'package-preview-2022-10-05' +``` yaml $(tag) == 'package-preview-2022-10-05' input-file: - Microsoft.CostManagement/preview/2022-10-05-preview/costmanagement.json - Microsoft.CostManagement/preview/2022-10-05-preview/settings.json @@ -334,6 +351,22 @@ directive: from: costmanagement.json where: $.definitions.ViewProperties.properties.accumulated reason: 'false alarm ' + - suppress: DeleteOperationResponses + from: costmanagement.budgets.json + reason: 'Consistent with delete api from other versions, modifying it will be a breaking change' + - suppress: TopLevelResourcesListBySubscription + from: costmanagement.budgets.json + reason: 'List by subscription is included in the Budgets_List operation with the scope path parameter' + - suppress: NoDuplicatePathsForScopeParameter + from: costmanagement.budgets.json + reason: 'Budgets_Get does not use an explicitly defined scope' + - suppress: ResourceMustReferenceCommonTypes + from: costmanagement.budgets.json + reason: 'Budget references CostManagementProxyResource, which references the common type ProxyResource' + - suppress: GetCollectionResponseSchema + from: common-types.json + reason: 'Operations does not contain a path for individual GET' + ``` ### Tag: package-2018-08-preview @@ -374,7 +407,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - - repo: azure-sdk-for-net + - repo: azure-sdk-for-net-track2 - repo: azure-sdk-for-go - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-node From 4f6418dca8c15697489bbe6f855558bb79ca5bf5 Mon Sep 17 00:00:00 2001 From: Nick Depinet Date: Wed, 3 May 2023 22:31:59 -0700 Subject: [PATCH 15/79] [Hub Generated] Publish private branch 'nickdepinet-devcenter-Microsoft.DevCenter-2023-04-01' (#23695) * add or modify files * Update readme.md re-add azure-sdk-for-go --- .../stable/2023-04-01/commonDefinitions.json | 212 + .../stable/2023-04-01/devcenter.json | 3900 +++++++++++++++++ .../examples/AttachedNetworks_Create.json | 35 + .../examples/AttachedNetworks_Delete.json | 19 + .../AttachedNetworks_GetByDevCenter.json | 32 + .../AttachedNetworks_GetByProject.json | 32 + .../AttachedNetworks_ListByDevCenter.json | 54 + .../AttachedNetworks_ListByProject.json | 54 + .../examples/Catalogs_CreateAdo.json | 46 + .../examples/Catalogs_CreateGitHub.json | 46 + .../2023-04-01/examples/Catalogs_Delete.json | 19 + .../2023-04-01/examples/Catalogs_Get.json | 37 + .../2023-04-01/examples/Catalogs_List.json | 40 + .../2023-04-01/examples/Catalogs_Patch.json | 50 + .../2023-04-01/examples/Catalogs_Sync.json | 17 + .../examples/CheckNameAvailability.json | 17 + .../examples/DevBoxDefinitions_Create.json | 75 + .../examples/DevBoxDefinitions_Delete.json | 19 + .../examples/DevBoxDefinitions_Get.json | 37 + .../DevBoxDefinitions_GetByProject.json | 37 + .../DevBoxDefinitions_ListByDevCenter.json | 41 + .../DevBoxDefinitions_ListByProject.json | 41 + .../examples/DevBoxDefinitions_Patch.json | 50 + .../examples/DevCenters_Create.json | 63 + .../DevCenters_CreateWithUserIdentity.json | 87 + .../examples/DevCenters_Delete.json | 18 + .../2023-04-01/examples/DevCenters_Get.json | 33 + .../DevCenters_ListByResourceGroup.json | 36 + .../DevCenters_ListBySubscription.json | 35 + .../2023-04-01/examples/DevCenters_Patch.json | 44 + .../examples/EnvironmentTypes_Delete.json | 13 + .../examples/EnvironmentTypes_Get.json | 29 + .../examples/EnvironmentTypes_List.json | 32 + .../examples/EnvironmentTypes_Patch.json | 34 + .../examples/EnvironmentTypes_Put.json | 34 + .../2023-04-01/examples/Galleries_Create.json | 35 + .../2023-04-01/examples/Galleries_Delete.json | 19 + .../2023-04-01/examples/Galleries_Get.json | 30 + .../2023-04-01/examples/Galleries_List.json | 50 + .../examples/ImageVersions_Get.json | 34 + .../examples/ImageVersions_List.json | 37 + .../2023-04-01/examples/Images_Get.json | 44 + .../examples/Images_ListByDevCenter.json | 75 + .../examples/Images_ListByGallery.json | 76 + .../examples/NetworkConnections_Delete.json | 18 + .../examples/NetworkConnections_Get.json | 35 + .../NetworkConnections_GetHealthDetails.json | 37 + ...etworkConnections_ListByResourceGroup.json | 37 + ...NetworkConnections_ListBySubscription.json | 36 + .../NetworkConnections_ListHealthDetails.json | 41 + ...tOutboundNetworkDependenciesEndpoints.json | 55 + .../examples/NetworkConnections_Patch.json | 44 + .../examples/NetworkConnections_Put.json | 69 + .../NetworkConnections_RunHealthChecks.json | 16 + .../examples/OperationStatus_Get.json | 38 + .../2023-04-01/examples/Operations_Get.json | 21 + .../2023-04-01/examples/Pools_Delete.json | 19 + .../stable/2023-04-01/examples/Pools_Get.json | 39 + .../examples/Pools_GetUnhealthyStatus.json | 53 + .../2023-04-01/examples/Pools_List.json | 42 + .../2023-04-01/examples/Pools_Patch.json | 50 + .../stable/2023-04-01/examples/Pools_Put.json | 80 + .../examples/Pools_RunHealthChecks.json | 18 + .../ProjectAllowedEnvironmentTypes_Get.json | 26 + .../ProjectAllowedEnvironmentTypes_List.json | 29 + .../ProjectEnvironmentTypes_Delete.json | 13 + .../examples/ProjectEnvironmentTypes_Get.json | 62 + .../ProjectEnvironmentTypes_List.json | 66 + .../ProjectEnvironmentTypes_Patch.json | 84 + .../examples/ProjectEnvironmentTypes_Put.json | 89 + .../2023-04-01/examples/Projects_Delete.json | 18 + .../2023-04-01/examples/Projects_Get.json | 34 + .../Projects_ListByResourceGroup.json | 38 + .../examples/Projects_ListBySubscription.json | 37 + .../2023-04-01/examples/Projects_Patch.json | 49 + .../2023-04-01/examples/Projects_Put.json | 69 + .../Projects_PutWithMaxDevBoxPerUser.json | 72 + ...dules_CreateDailyShutdownPoolSchedule.json | 67 + .../2023-04-01/examples/Schedules_Delete.json | 20 + .../2023-04-01/examples/Schedules_Get.json | 35 + .../examples/Schedules_ListByPool.json | 38 + .../2023-04-01/examples/Schedules_Patch.json | 46 + .../examples/Skus_ListBySubscription.json | 30 + .../examples/Usages_ListByLocation.json | 32 + .../stable/2023-04-01/vdi.json | 1771 ++++++++ .../devcenter/resource-manager/readme.md | 15 +- 86 files changed, 9254 insertions(+), 2 deletions(-) create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/commonDefinitions.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/devcenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_GetByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_CreateAdo.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_CreateGitHub.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Sync.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/CheckNameAvailability.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_GetByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_ListByProject.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_CreateWithUserIdentity.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Create.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ImageVersions_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ImageVersions_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_ListByDevCenter.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_ListByGallery.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_GetHealthDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListHealthDetails.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_RunHealthChecks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/OperationStatus_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Operations_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_GetUnhealthyStatus.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_RunHealthChecks.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectAllowedEnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectAllowedEnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_List.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_ListByResourceGroup.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Put.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_PutWithMaxDevBoxPerUser.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_CreateDailyShutdownPoolSchedule.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Delete.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Get.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_ListByPool.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Patch.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Skus_ListBySubscription.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Usages_ListByLocation.json create mode 100644 specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/vdi.json diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/commonDefinitions.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/commonDefinitions.json new file mode 100644 index 000000000000..5894c2e1d973 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/commonDefinitions.json @@ -0,0 +1,212 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "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": {}, + "definitions": { + "Capability": { + "description": "A name/value pair to describe a capability.", + "type": "object", + "properties": { + "name": { + "description": "Name of the capability.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Value of the capability.", + "type": "string", + "readOnly": true + } + } + }, + "TrackedResourceUpdate": { + "description": "Base tracked resource type for PATCH updates", + "type": "object", + "properties": { + "tags": { + "$ref": "#/definitions/Tags", + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + } + } + }, + "Tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "CloudError": { + "x-ms-external": true, + "type": "object", + "properties": { + "error": { + "description": "Error body", + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the DevCenter service.", + "required": [ + "error" + ] + }, + "CloudErrorBody": { + "x-ms-external": true, + "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/CloudErrorBody" + }, + "x-ms-identifiers": [], + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the DevCenter service.", + "required": [ + "code", + "message" + ] + }, + "DevCenterSku": { + "description": "The resource model definition representing SKU for DevCenter resources", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + } + ], + "properties": { + "resourceType": { + "type": "string", + "description": "The name of the resource type", + "readOnly": true + }, + "locations": { + "description": "SKU supported locations.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + }, + "capabilities": { + "description": "Collection of name/value pairs to describe the SKU capabilities.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Capability" + }, + "x-ms-identifiers": [] + } + }, + "required": [ + "name" + ] + }, + "ProvisioningState": { + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Creating", + "Created", + "Updating", + "Updated", + "Deleting", + "Deleted", + "Succeeded", + "Failed", + "Canceled", + "MovingResources", + "TransientFailure", + "RolloutInProgress", + "StorageProvisioningFailed" + ], + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + }, + "parameters": { + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the project.", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "description": "The maximum number of resources to return from the operation. Example: '$top=10'.", + "type": "integer", + "format": "int32", + "required": false, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/devcenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/devcenter.json new file mode 100644 index 000000000000..e0b943d07a23 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/devcenter.json @@ -0,0 +1,3900 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "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.DevCenter/devcenters": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Lists all devcenters in a subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "DevCenters_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevCenters_ListBySubscription": { + "$ref": "./examples/DevCenters_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Lists all devcenters in a 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" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "DevCenters_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevCenters_ListByResourceGroup": { + "$ref": "./examples/DevCenters_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}": { + "get": { + "tags": [ + "DevCenters" + ], + "description": "Gets a devcenter.", + "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/DevCenterNameParameter" + } + ], + "operationId": "DevCenters_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevCenters_Get": { + "$ref": "./examples/DevCenters_Get.json" + } + } + }, + "put": { + "tags": [ + "DevCenters" + ], + "description": "Creates or updates a devcenter 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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a devcenter.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenter" + } + } + ], + "operationId": "DevCenters_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "201": { + "description": "Created. The request will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevCenters_Create": { + "$ref": "./examples/DevCenters_Create.json" + }, + "DevCenters_CreateWithUserIdentity": { + "$ref": "./examples/DevCenters_CreateWithUserIdentity.json" + } + } + }, + "patch": { + "tags": [ + "DevCenters" + ], + "description": "Partially updates a devcenter.", + "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/DevCenterNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable devcenter properties.", + "required": true, + "schema": { + "$ref": "#/definitions/DevCenterUpdate" + } + } + ], + "operationId": "DevCenters_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevCenter" + } + }, + "202": { + "description": "Accepted. The request will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevCenters_Update": { + "$ref": "./examples/DevCenters_Patch.json" + } + } + }, + "delete": { + "tags": [ + "DevCenters" + ], + "description": "Deletes a devcenter", + "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/DevCenterNameParameter" + } + ], + "operationId": "DevCenters_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Resource has been deleted" + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevCenters_Delete": { + "$ref": "./examples/DevCenters_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/projects": { + "get": { + "tags": [ + "Projects" + ], + "description": "Lists all projects in the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Projects_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Projects_ListBySubscription": { + "$ref": "./examples/Projects_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects": { + "get": { + "tags": [ + "Projects" + ], + "description": "Lists all projects in the 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" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Projects_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Projects_ListByResourceGroup": { + "$ref": "./examples/Projects_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}": { + "get": { + "tags": [ + "Projects" + ], + "description": "Gets a specific project.", + "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/ProjectNameParameter" + } + ], + "operationId": "Projects_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Projects_Get": { + "$ref": "./examples/Projects_Get.json" + } + } + }, + "put": { + "tags": [ + "Projects" + ], + "description": "Creates or updates a project.", + "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/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a project.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "operationId": "Projects_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Projects_CreateOrUpdate": { + "$ref": "./examples/Projects_Put.json" + }, + "Projects_CreateOrUpdateWithLimitsPerDev": { + "$ref": "./examples/Projects_PutWithMaxDevBoxPerUser.json" + } + } + }, + "patch": { + "tags": [ + "Projects" + ], + "description": "Partially updates a project.", + "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/ProjectNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectUpdate" + } + } + ], + "operationId": "Projects_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Projects_Update": { + "$ref": "./examples/Projects_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Projects" + ], + "description": "Deletes a project 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" + }, + { + "$ref": "#/parameters/ProjectNameParameter" + } + ], + "operationId": "Projects_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Resource has been deleted" + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Projects_Delete": { + "$ref": "./examples/Projects_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/attachednetworks": { + "get": { + "tags": [ + "Attached NetworkConnections." + ], + "description": "Lists the attached NetworkConnections for a Project.", + "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/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "AttachedNetworks_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_ListByProject": { + "$ref": "./examples/AttachedNetworks_ListByProject.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/attachednetworks/{attachedNetworkConnectionName}": { + "get": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Gets an attached NetworkConnection.", + "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/ProjectNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_GetByProject": { + "$ref": "./examples/AttachedNetworks_GetByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries": { + "get": { + "tags": [ + "Galleries" + ], + "description": "Lists galleries for a devcenter.", + "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/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Galleries_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/GalleryListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Galleries_ListByDevCenter": { + "$ref": "./examples/Galleries_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}": { + "get": { + "tags": [ + "Galleries" + ], + "description": "Gets a gallery", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + } + ], + "operationId": "Galleries_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Galleries_Get": { + "$ref": "./examples/Galleries_Get.json" + } + } + }, + "put": { + "tags": [ + "Galleries" + ], + "description": "Creates or updates a gallery.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a gallery.", + "required": true, + "schema": { + "$ref": "#/definitions/Gallery" + } + } + ], + "operationId": "Galleries_CreateOrUpdate", + "responses": { + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Gallery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Galleries_CreateOrUpdate": { + "$ref": "./examples/Galleries_Create.json" + } + } + }, + "delete": { + "tags": [ + "Galleries" + ], + "description": "Deletes a gallery 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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + } + ], + "operationId": "Galleries_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Resource has been deleted" + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Galleries_Delete": { + "$ref": "./examples/Galleries_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a devcenter.", + "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/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Images_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Images_ListByDevCenter": { + "$ref": "./examples/Images_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images": { + "get": { + "tags": [ + "Images" + ], + "description": "Lists images for a gallery.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Images_ListByGallery", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Images_ListByGallery": { + "$ref": "./examples/Images_ListByGallery.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}": { + "get": { + "tags": [ + "Images" + ], + "description": "Gets a gallery image.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + } + ], + "operationId": "Images_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Images_Get": { + "$ref": "./examples/Images_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}/versions": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Lists versions for an image.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + } + ], + "operationId": "ImageVersions_ListByImage", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ImageVersions_ListByImage": { + "$ref": "./examples/ImageVersions_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/galleries/{galleryName}/images/{imageName}/versions/{versionName}": { + "get": { + "tags": [ + "Image Versions" + ], + "description": "Gets an image version.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/GalleryNameParameter" + }, + { + "$ref": "#/parameters/ImageNameParameter" + }, + { + "$ref": "#/parameters/VersionNameParameter" + } + ], + "operationId": "ImageVersions_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ImageVersion" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Versions_Get": { + "$ref": "./examples/ImageVersions_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks": { + "get": { + "tags": [ + "Attached NetworkConnections." + ], + "description": "Lists the attached NetworkConnections for a DevCenter.", + "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/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "AttachedNetworks_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_ListByDevCenter": { + "$ref": "./examples/AttachedNetworks_ListByDevCenter.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/attachednetworks/{attachedNetworkConnectionName}": { + "get": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Gets an attached NetworkConnection.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_GetByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_GetByDevCenter": { + "$ref": "./examples/AttachedNetworks_GetByDevCenter.json" + } + } + }, + "put": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Creates or updates an attached NetworkConnection.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an attached NetworkConnection.", + "required": true, + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + } + ], + "operationId": "AttachedNetworks_CreateOrUpdate", + "responses": { + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AttachedNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "AttachedNetworks_Create": { + "$ref": "./examples/AttachedNetworks_Create.json" + } + } + }, + "delete": { + "tags": [ + "Attached NetworkConnections" + ], + "description": "Un-attach a NetworkConnection.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/AttachedNetworkConnectionNameParameter" + } + ], + "operationId": "AttachedNetworks_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Resource has been deleted" + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AttachedNetworks_Delete": { + "$ref": "./examples/AttachedNetworks_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Lists catalogs for a devcenter.", + "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/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "Catalogs_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CatalogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Catalogs_ListByDevCenter": { + "$ref": "./examples/Catalogs_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}": { + "get": { + "tags": [ + "Catalogs" + ], + "description": "Gets a catalog", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Catalogs_Get": { + "$ref": "./examples/Catalogs_Get.json" + } + } + }, + "put": { + "tags": [ + "Catalogs" + ], + "description": "Creates or updates a catalog.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a catalog.", + "required": true, + "schema": { + "$ref": "#/definitions/Catalog" + } + } + ], + "operationId": "Catalogs_CreateOrUpdate", + "responses": { + "201": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_CreateOrUpdateGitHub": { + "$ref": "./examples/Catalogs_CreateGitHub.json" + }, + "Catalogs_CreateOrUpdateAdo": { + "$ref": "./examples/Catalogs_CreateAdo.json" + } + } + }, + "patch": { + "tags": [ + "Catalogs" + ], + "description": "Partially updates a catalog.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable catalog properties.", + "required": true, + "schema": { + "$ref": "#/definitions/CatalogUpdate" + } + } + ], + "operationId": "Catalogs_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/Catalog" + } + }, + "202": { + "description": "The request will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Update": { + "$ref": "./examples/Catalogs_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Catalogs" + ], + "description": "Deletes a catalog 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" + }, + { + "$ref": "#/parameters/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Resource has been deleted" + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Catalogs_Delete": { + "$ref": "./examples/Catalogs_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/catalogs/{catalogName}/sync": { + "post": { + "tags": [ + "Catalogs" + ], + "description": "Syncs templates for a template source.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/CatalogNameParameter" + } + ], + "operationId": "Catalogs_Sync", + "responses": { + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Catalogs_Sync": { + "$ref": "./examples/Catalogs_Sync.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists environment types for the devcenter.", + "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/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "EnvironmentTypes_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_ListByDevCenter": { + "$ref": "./examples/EnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/environmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets an environment type.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "EnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Get": { + "$ref": "./examples/EnvironmentTypes_Get.json" + } + } + }, + "put": { + "tags": [ + "Environment Types" + ], + "description": "Creates or updates an environment type.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents an Environment Type.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + } + ], + "operationId": "EnvironmentTypes_CreateOrUpdate", + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_CreateOrUpdate": { + "$ref": "./examples/EnvironmentTypes_Put.json" + } + } + }, + "patch": { + "tags": [ + "Environment Types" + ], + "description": "Partially updates an environment type.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable environment type properties.", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentTypeUpdate" + } + } + ], + "operationId": "EnvironmentTypes_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Update": { + "$ref": "./examples/EnvironmentTypes_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Environment Types" + ], + "description": "Deletes an environment type.", + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "EnvironmentTypes_Delete", + "responses": { + "200": { + "description": "OK. Resource has been deleted" + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "EnvironmentTypes_Delete": { + "$ref": "./examples/EnvironmentTypes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/allowedEnvironmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists allowed environment types for a project.", + "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/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectAllowedEnvironmentTypes_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AllowedEnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ProjectAllowedEnvironmentTypes_List": { + "$ref": "./examples/ProjectAllowedEnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/allowedEnvironmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets an allowed environment type.", + "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/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectAllowedEnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AllowedEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ProjectAllowedEnvironmentTypes_Get": { + "$ref": "./examples/ProjectAllowedEnvironmentTypes_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Lists environment types for a project.", + "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/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_List", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentTypeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_List": { + "$ref": "./examples/ProjectEnvironmentTypes_List.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/environmentTypes/{environmentTypeName}": { + "get": { + "tags": [ + "Environment Types" + ], + "description": "Gets a project environment type.", + "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/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Get": { + "$ref": "./examples/ProjectEnvironmentTypes_Get.json" + } + } + }, + "put": { + "tags": [ + "Environment Types" + ], + "description": "Creates or updates a project environment type.", + "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/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Represents a Project Environment Type.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + } + ], + "operationId": "ProjectEnvironmentTypes_CreateOrUpdate", + "responses": { + "200": { + "description": "Succeeded", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_CreateOrUpdate": { + "$ref": "./examples/ProjectEnvironmentTypes_Put.json" + } + } + }, + "patch": { + "tags": [ + "Environment Types" + ], + "description": "Partially updates a project environment type.", + "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/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + }, + { + "name": "body", + "in": "body", + "description": "Updatable project environment type properties.", + "required": true, + "schema": { + "$ref": "#/definitions/ProjectEnvironmentTypeUpdate" + } + } + ], + "operationId": "ProjectEnvironmentTypes_Update", + "responses": { + "200": { + "description": "The resource was updated.", + "schema": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Update": { + "$ref": "./examples/ProjectEnvironmentTypes_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Environment Types" + ], + "description": "Deletes a project environment type.", + "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/ProjectNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentTypeNameParameter" + } + ], + "operationId": "ProjectEnvironmentTypes_Delete", + "responses": { + "200": { + "description": "OK. Resource has been deleted" + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ProjectEnvironmentTypes_Delete": { + "$ref": "./examples/ProjectEnvironmentTypes_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions": { + "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/DevCenterNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "List Dev Box definitions for a devcenter.", + "operationId": "DevBoxDefinitions_ListByDevCenter", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DevBoxDefinitions_ListByDevCenter": { + "$ref": "./examples/DevBoxDefinitions_ListByDevCenter.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/devcenters/{devCenterName}/devboxdefinitions/{devBoxDefinitionName}": { + "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/DevCenterNameParameter" + }, + { + "$ref": "#/parameters/DevBoxDefinitionName" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Gets a Dev Box definition", + "operationId": "DevBoxDefinitions_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Get": { + "$ref": "./examples/DevBoxDefinitions_Get.json" + } + } + }, + "put": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Creates or updates a Dev Box definition.", + "operationId": "DevBoxDefinitions_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a Dev Box definition.", + "required": true, + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "201": { + "description": "Created. The operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Create": { + "$ref": "./examples/DevBoxDefinitions_Create.json" + } + } + }, + "patch": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Partially updates a Dev Box definition.", + "operationId": "DevBoxDefinitions_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a Dev Box definition.", + "required": true, + "schema": { + "$ref": "#/definitions/DevBoxDefinitionUpdate" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Patch": { + "$ref": "./examples/DevBoxDefinitions_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Deletes a Dev Box definition", + "operationId": "DevBoxDefinitions_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Resource has been deleted." + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_Delete": { + "$ref": "./examples/DevBoxDefinitions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions": { + "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/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "List Dev Box definitions configured for a project.", + "operationId": "DevBoxDefinitions_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DevBoxDefinitions_ListByProject": { + "$ref": "./examples/DevBoxDefinitions_ListByProject.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/devboxdefinitions/{devBoxDefinitionName}": { + "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/ProjectNameParameter" + }, + { + "$ref": "#/parameters/DevBoxDefinitionName" + } + ], + "get": { + "tags": [ + "Dev Box Definitions" + ], + "description": "Gets a Dev Box definition configured for a project", + "operationId": "DevBoxDefinitions_GetByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DevBoxDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DevBoxDefinitions_GetByProject": { + "$ref": "./examples/DevBoxDefinitions_GetByProject.json" + } + } + } + }, + "/providers/Microsoft.DevCenter/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available resource provider operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationListResult" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Operations_Get": { + "$ref": "./examples/Operations_Get.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/locations/{location}/operationStatuses/{operationId}": { + "get": { + "description": "Gets the current status of an async operation.", + "operationId": "OperationStatuses_Get", + "summary": "Get Operation Status", + "tags": [ + "OperationStatus" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/OperationIdParameter" + } + ], + "responses": { + "200": { + "description": "The requested operation status", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "202": { + "description": "The requested operation status", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Resource Provider error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/OperationStatus_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/locations/{location}/usages": { + "get": { + "operationId": "Usages_ListByLocation", + "description": "Lists the current usages and limits in this location for the provided subscription.", + "tags": [ + "Usages" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; a list of usages is returned", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + }, + "default": { + "description": "The default error response.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "listUsages": { + "$ref": "./examples/Usages_ListByLocation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/checkNameAvailability": { + "post": { + "tags": [ + "CheckNameAvailability" + ], + "operationId": "CheckNameAvailability_Execute", + "x-ms-examples": { + "NameAvailability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "description": "Check the availability of name for resource", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "nameAvailabilityRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityRequest" + }, + "description": "The required parameters for checking if resource name is available." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/CheckNameAvailabilityResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "DevCenter": { + "type": "object", + "description": "Represents a devcenter resource.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "DevCenter properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevCenterProperties" + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "DevCenterProperties": { + "description": "Properties of the devcenter.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "devCenterUri": { + "description": "The URI of the Dev Center.", + "$ref": "#/definitions/DevCenterUri" + } + } + }, + "DevCenterUpdate": { + "description": "The devcenter resource for partial updates. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "DevCenterListResult": { + "description": "Result of the list devcenters operation", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DevCenter" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevCenterUri": { + "description": "The URI of the resource.", + "readOnly": true, + "type": "string" + }, + "Project": { + "description": "Represents a project resource.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectProperties", + "description": "Properties of a project." + } + } + }, + "ProjectUpdateProperties": { + "description": "Properties of a project. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devCenterId": { + "type": "string", + "description": "Resource Id of an associated DevCenter" + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "maxDevBoxesPerUser": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "When specified, limits the maximum number of Dev Boxes a single user can create across all pools in the project. This will have no effect on existing Dev Boxes when reduced." + } + } + }, + "ProjectProperties": { + "description": "Properties of a project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProjectUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "devCenterUri": { + "description": "The URI of the Dev Center resource this project is associated with.", + "$ref": "#/definitions/DevCenterUri" + } + } + }, + "ProjectUpdate": { + "description": "The project properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectUpdateProperties", + "description": "Properties of a project to be updated." + } + } + }, + "ProjectListResult": { + "description": "Results of the project list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Project" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Catalog": { + "description": "Represents a catalog.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CatalogProperties", + "description": "Catalog properties." + } + } + }, + "CatalogUpdateProperties": { + "description": "Properties of a catalog. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "gitHub": { + "description": "Properties for a GitHub catalog type.", + "$ref": "#/definitions/GitCatalog" + }, + "adoGit": { + "description": "Properties for an Azure DevOps catalog type.", + "$ref": "#/definitions/GitCatalog" + } + } + }, + "CatalogProperties": { + "description": "Properties of a catalog.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CatalogUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "syncState": { + "enum": [ + "Succeeded", + "InProgress", + "Failed", + "Canceled" + ], + "description": "The synchronization state of the catalog.", + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "CatalogSyncState", + "modelAsString": true + } + }, + "lastSyncTime": { + "description": "When the catalog was last synced.", + "type": "string", + "readOnly": true, + "format": "date-time" + } + } + }, + "GitCatalog": { + "description": "Properties for a Git repository catalog.", + "type": "object", + "properties": { + "uri": { + "description": "Git URI.", + "type": "string" + }, + "branch": { + "description": "Git branch.", + "type": "string" + }, + "secretIdentifier": { + "description": "A reference to the Key Vault secret containing a security token to authenticate to a Git repository.", + "type": "string" + }, + "path": { + "description": "The folder where the catalog items can be found inside the repository.", + "type": "string" + } + } + }, + "CatalogUpdate": { + "description": "The catalog's properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CatalogUpdateProperties", + "description": "Catalog properties for update." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + } + } + }, + "CatalogListResult": { + "description": "Results of the catalog list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Catalog" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Gallery": { + "description": "Represents a gallery.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/GalleryProperties", + "description": "Gallery properties." + } + } + }, + "GalleryProperties": { + "description": "Properties of a gallery.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "galleryResourceId": { + "description": "The resource ID of the backing Azure Compute Gallery.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "galleryResourceId" + ] + }, + "Image": { + "description": "Represents an image.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties", + "description": "Image properties." + } + } + }, + "ImageProperties": { + "description": "Properties of an image.", + "type": "object", + "properties": { + "description": { + "description": "The description of the image.", + "type": "string", + "readOnly": true + }, + "publisher": { + "description": "The publisher of the image.", + "type": "string", + "readOnly": true + }, + "offer": { + "description": "The name of the image offer.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "The SKU name for the image.", + "type": "string", + "readOnly": true + }, + "recommendedMachineConfiguration": { + "description": "The recommended machine configuration to use with the image.", + "$ref": "#/definitions/RecommendedMachineConfiguration", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "hibernateSupport": { + "description": "Indicates whether this image has hibernate enabled. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate", + "readOnly": true, + "$ref": "#/definitions/HibernateSupport" + } + } + }, + "RecommendedMachineConfiguration": { + "description": "Properties for a recommended machine configuration.", + "type": "object", + "properties": { + "memory": { + "description": "Recommended memory range.", + "$ref": "#/definitions/ResourceRange", + "readOnly": true + }, + "vCPUs": { + "description": "Recommended vCPU range.", + "$ref": "#/definitions/ResourceRange", + "readOnly": true + } + } + }, + "ResourceRange": { + "description": "Properties for a range of values.", + "type": "object", + "properties": { + "min": { + "description": "Minimum value.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "max": { + "description": "Maximum value.", + "type": "integer", + "format": "int32", + "readOnly": true + } + } + }, + "ImageVersion": { + "description": "Represents an image version.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageVersionProperties", + "description": "Image version properties." + } + } + }, + "ImageVersionProperties": { + "description": "Properties of an image version.", + "type": "object", + "properties": { + "name": { + "description": "The semantic version string.", + "type": "string", + "readOnly": true + }, + "publishedDate": { + "description": "The datetime that the backing image version was published.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "excludeFromLatest": { + "description": "If the version should be excluded from being treated as the latest version.", + "type": "boolean", + "readOnly": true + }, + "osDiskImageSizeInGb": { + "description": "The size of the OS disk image, in GB.", + "type": "integer", + "format": "int32", + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "GalleryListResult": { + "description": "Results of the gallery list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Gallery" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageListResult": { + "description": "Results of the image list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Image" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ImageVersionListResult": { + "description": "Results of the image version list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ImageVersion" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "AllowedEnvironmentType": { + "description": "Represents an allowed environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AllowedEnvironmentTypeProperties", + "description": "Properties of an allowed environment type." + } + } + }, + "AllowedEnvironmentTypeProperties": { + "description": "Properties of an allowed environment type.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "AllowedEnvironmentTypeListResult": { + "description": "Result of the allowed environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AllowedEnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentType": { + "description": "Represents an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnvironmentTypeProperties", + "description": "Properties of an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "EnvironmentTypeProperties": { + "description": "Properties of an environment type.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "EnvironmentTypeUpdate": { + "description": "The environment type for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + } + } + }, + "EnvironmentTypeListResult": { + "description": "Result of the environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ProjectEnvironmentType": { + "description": "Represents an environment type.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectEnvironmentTypeProperties", + "description": "Properties of an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + }, + "location": { + "type": "string", + "description": "The geo-location for the environment type" + } + } + }, + "ProjectEnvironmentTypeUpdateProperties": { + "description": "Properties of a project environment type. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "deploymentTargetId": { + "description": "Id of a subscription that the environment type will be mapped to. The environment's resources will be deployed into this subscription.", + "type": "string" + }, + "status": { + "description": "Defines whether this Environment Type can be used in this Project.", + "$ref": "#/definitions/EnvironmentTypeEnableStatus" + }, + "creatorRoleAssignment": { + "description": "The role definition assigned to the environment creator on backing resources.", + "type": "object", + "properties": { + "roles": { + "type": "object", + "description": "A map of roles to assign to the environment creator.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentRole" + } + } + } + }, + "userRoleAssignments": { + "description": "Role Assignments created on environment backing resources. This is a mapping from a user object ID to an object of role definition IDs.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserRoleAssignment" + } + } + } + }, + "ProjectEnvironmentTypeProperties": { + "description": "Properties of a project environment type.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProjectEnvironmentTypeUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + } + }, + "ProjectEnvironmentTypeUpdate": { + "description": "The project environment type for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProjectEnvironmentTypeUpdateProperties", + "description": "Properties to configure an environment type." + }, + "tags": { + "$ref": "commonDefinitions.json#/definitions/Tags", + "description": "Resource tags." + }, + "identity": { + "description": "Managed identity properties", + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity" + } + } + }, + "ProjectEnvironmentTypeListResult": { + "description": "Result of the project environment type list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ProjectEnvironmentType" + } + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevBoxDefinitionListResult": { + "description": "Results of the Dev Box definition list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/DevBoxDefinition" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DevBoxDefinitionUpdate": { + "description": "Partial update of a Dev Box definition resource.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevBoxDefinitionUpdateProperties", + "description": "Properties of a Dev Box definition to be updated." + } + } + }, + "DevBoxDefinition": { + "description": "Represents a definition for a Developer Machine.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Dev Box definition properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DevBoxDefinitionProperties" + } + } + }, + "DevBoxDefinitionUpdateProperties": { + "description": "Properties of a Dev Box definition. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "imageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information." + }, + "sku": { + "description": "The SKU for Dev Boxes created using this definition.", + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Sku" + }, + "osStorageType": { + "description": "The storage type used for the Operating System disk of Dev Boxes created using this definition.", + "type": "string" + }, + "hibernateSupport": { + "description": "Indicates whether Dev Boxes created with this definition are capable of hibernation. Not all images are capable of supporting hibernation. To find out more see https://aka.ms/devbox/hibernate", + "$ref": "#/definitions/HibernateSupport" + } + } + }, + "DevBoxDefinitionProperties": { + "description": "Properties of a Dev Box definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DevBoxDefinitionUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "imageValidationStatus": { + "description": "Validation status of the configured image.", + "$ref": "vdi.json#/definitions/ImageValidationStatus", + "readOnly": true + }, + "imageValidationErrorDetails": { + "description": "Details for image validator error. Populated when the image validation is not successful.", + "$ref": "vdi.json#/definitions/ImageValidationErrorDetails", + "readOnly": true + }, + "activeImageReference": { + "$ref": "vdi.json#/definitions/ImageReference", + "description": "Image reference information for the currently active image (only populated during updates).", + "readOnly": true + } + }, + "required": [ + "imageReference", + "sku" + ] + }, + "AttachedNetworkConnection": { + "description": "Represents an attached NetworkConnection.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AttachedNetworkConnectionProperties", + "description": "Attached NetworkConnection properties." + } + } + }, + "AttachedNetworkConnectionProperties": { + "description": "Properties of an attached NetworkConnection.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "networkConnectionId": { + "description": "The resource ID of the NetworkConnection you want to attach.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "networkConnectionLocation": { + "description": "The geo-location where the NetworkConnection resource specified in 'networkConnectionResourceId' property lives.", + "type": "string", + "readOnly": true + }, + "healthCheckStatus": { + "$ref": "vdi.json#/definitions/HealthCheckStatus", + "readOnly": true + }, + "domainJoinType": { + "description": "AAD Join type of the network. This is populated based on the referenced Network Connection.", + "$ref": "vdi.json#/definitions/DomainJoinType", + "readOnly": true + } + }, + "required": [ + "networkConnectionId" + ] + }, + "AttachedNetworkListResult": { + "description": "Results of the Attached Networks list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/AttachedNetworkConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "EnvironmentRole": { + "type": "object", + "description": "A role that can be assigned to a user.", + "properties": { + "roleName": { + "description": "The common name of the Role Assignment. This is a descriptive name such as 'AcrPush'.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "This is a description of the Role Assignment.", + "type": "string", + "readOnly": true + } + } + }, + "UserRoleAssignment": { + "type": "object", + "description": "Mapping of user object ID to role assignments.", + "x-ms-client-name": "userRoleAssignmentValue", + "properties": { + "roles": { + "type": "object", + "description": "A map of roles to assign to the parent user.", + "additionalProperties": { + "$ref": "#/definitions/EnvironmentRole" + } + } + } + }, + "OperationStatus": { + "description": "The current status of an async operation", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult" + } + ], + "properties": { + "resourceId": { + "description": "The id of the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "description": "Custom operation properties, populated only for a successful operation.", + "type": "object", + "readOnly": true + } + } + }, + "EnvironmentTypeEnableStatus": { + "description": "Indicates whether the environment type is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EnvironmentTypeEnableStatus", + "modelAsString": true + } + }, + "HibernateSupport": { + "description": "Indicates whether hibernate is enabled/disabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "HibernateSupport", + "modelAsString": true + } + }, + "ListUsagesResult": { + "description": "List of Core Usages.", + "type": "object", + "properties": { + "value": { + "description": "The array page of Usages.", + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "The link to get the next page of Usage result.", + "type": "string", + "readOnly": true + } + } + }, + "Usage": { + "description": "The core usage details.", + "type": "object", + "properties": { + "currentValue": { + "description": "The current usage.", + "type": "integer", + "format": "int64" + }, + "limit": { + "description": "The limit integer.", + "type": "integer", + "format": "int64" + }, + "unit": { + "description": "The unit details.", + "type": "string", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "name": { + "description": "The name.", + "$ref": "#/definitions/UsageName" + } + } + }, + "UsageName": { + "description": "The Usage Names.", + "type": "object", + "properties": { + "localizedValue": { + "description": "The localized name of the resource.", + "type": "string" + }, + "value": { + "description": "The name of the resource.", + "type": "string" + } + } + } + }, + "parameters": { + "DevCenterNameParameter": { + "name": "devCenterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the devcenter.", + "x-ms-parameter-location": "method" + }, + "ProjectNameParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the project.", + "x-ms-parameter-location": "method" + }, + "CatalogNameParameter": { + "name": "catalogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Catalog.", + "x-ms-parameter-location": "method" + }, + "GalleryNameParameter": { + "name": "galleryName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gallery.", + "x-ms-parameter-location": "method" + }, + "ImageNameParameter": { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image.", + "x-ms-parameter-location": "method" + }, + "VersionNameParameter": { + "name": "versionName", + "in": "path", + "required": true, + "type": "string", + "description": "The version of the image.", + "x-ms-parameter-location": "method" + }, + "EnvironmentTypeNameParameter": { + "name": "environmentTypeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the environment type.", + "x-ms-parameter-location": "method" + }, + "AttachedNetworkConnectionNameParameter": { + "name": "attachedNetworkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the attached NetworkConnection.", + "x-ms-parameter-location": "method" + }, + "DevBoxDefinitionName": { + "name": "devBoxDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Dev Box definition.", + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName').", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "description": "The Azure region", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "description": "The ID of an ongoing async operation", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_Create.json new file mode 100644 index 000000000000..c41eac051f7d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_Create.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3", + "body": { + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_Delete.json new file mode 100644 index 000000000000..85ee8888eead --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_GetByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_GetByDevCenter.json new file mode 100644 index 000000000000..e680b96c6896 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_GetByDevCenter.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/devcenters/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_GetByProject.json new file mode 100644 index 000000000000..5c81ce88fef0 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_GetByProject.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "attachedNetworkConnectionName": "network-uswest3" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/network-uswest3", + "name": "network-uswest3", + "type": "Microsoft.DevCenter/projects/attachednetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_ListByDevCenter.json new file mode 100644 index 000000000000..3cd61c188c4f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_ListByDevCenter.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/netmap1", + "name": "netmap1", + "type": "Microsoft.DevCenter/devcenters/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "Application", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/attachednetworks/netmap2", + "name": "netmap2", + "type": "Microsoft.DevCenter/devcenters/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_ListByProject.json new file mode 100644 index 000000000000..223eca2d16bc --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/AttachedNetworks_ListByProject.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/netmap1", + "name": "netmap1", + "type": "Microsoft.DevCenter/projects/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "Application", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/attachednetworks/netmap2", + "name": "netmap2", + "type": "Microsoft.DevCenter/projects/attachedNetworks", + "properties": { + "networkConnectionId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/NetworkConnections/network-uswest3", + "networkConnectionLocation": "centralus", + "healthCheckStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_CreateAdo.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_CreateAdo.json new file mode 100644 index 000000000000..0e4de08d0134 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_CreateAdo.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "adoGit": { + "uri": "https://contoso@dev.azure.com/contoso/contosoOrg/_git/centralrepo-fakecontoso", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "provisioningState": "Accepted", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_CreateGitHub.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_CreateGitHub.json new file mode 100644 index 000000000000..6dede2902ea8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_CreateGitHub.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "provisioningState": "Accepted", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Delete.json new file mode 100644 index 000000000000..7cb6bddaba86 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Get.json new file mode 100644 index 000000000000..ccf03d9c792d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_List.json new file mode 100644 index 000000000000..48a50ffecef3 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_List.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/templates" + }, + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Patch.json new file mode 100644 index 000000000000..218ee1f38a18 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Patch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog", + "body": { + "properties": { + "gitHub": { + "path": "/environments" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/catalogs/CentralCatalog", + "name": "CentralCatalog", + "type": "Microsoft.DevCenter/devcenters/catalogs", + "properties": { + "gitHub": { + "uri": "https://github.com/Contoso/centralrepo-fake.git", + "branch": "main", + "secretIdentifier": "https://contosokv.vault.azure.net/secrets/CentralRepoPat", + "path": "/environments" + }, + "lastSyncTime": "2020-11-18T18:28:00.314Z", + "provisioningState": "Succeeded", + "syncState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Sync.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Sync.json new file mode 100644 index 000000000000..c37dc5ab2fb1 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Catalogs_Sync.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "catalogName": "CentralCatalog" + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/CheckNameAvailability.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..828e4001e1c6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/CheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "nameAvailabilityRequest": { + "name": "name1", + "type": "Microsoft.DevCenter/devcenters" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Create.json new file mode 100644 index 000000000000..0f46cdb47c7d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Create.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox", + "body": { + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/devBoxDefinitionName", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Created" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Delete.json new file mode 100644 index 000000000000..d75f11c59b12 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Get.json new file mode 100644 index 000000000000..85b8da801e0e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Get.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_GetByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_GetByProject.json new file mode 100644 index 000000000000..c65c4788676b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_GetByProject.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_ListByDevCenter.json new file mode 100644 index 000000000000..fc2e3d9ac9fc --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_ListByDevCenter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_ListByProject.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_ListByProject.json new file mode 100644 index 000000000000..4fb1bbac68d8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_ListByProject.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProject", + "devBoxDefinitionName": "WebDevBox" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProject/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/projects/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Patch.json new file mode 100644 index 000000000000..698269eb15c5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevBoxDefinitions_Patch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "devBoxDefinitionName": "WebDevBox", + "body": { + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/devboxdefinitions/WebDevBox", + "name": "WebDevBox", + "type": "Microsoft.DevCenter/devcenters/devboxdefinitions", + "properties": { + "imageReference": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" + }, + "sku": { + "name": "Preview" + }, + "hibernateSupport": "Enabled", + "provisioningState": "Succeeded" + }, + "location": "centralus", + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Create.json new file mode 100644 index 000000000000..4539e1d7046c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Create.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_CreateWithUserIdentity.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_CreateWithUserIdentity.json new file mode 100644 index 000000000000..da506ecf56b1 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_CreateWithUserIdentity.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": {}, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Accepted", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Delete.json new file mode 100644 index 000000000000..fc4b41a6fc66 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Get.json new file mode 100644 index 000000000000..1003924fb785 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_ListByResourceGroup.json new file mode 100644 index 000000000000..7ffb69eacf9c --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_ListByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_ListBySubscription.json new file mode 100644 index 000000000000..59b24e7cd2e6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_ListBySubscription.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:08.896Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Patch.json new file mode 100644 index 000000000000..91c49a922449 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/DevCenters_Patch.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "body": { + "tags": { + "CostCode": "12345" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "name": "Contoso", + "type": "Microsoft.DevCenter/devcenters", + "tags": { + "CostCode": "12345" + }, + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-11T22:00:08.896Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-11T22:00:10.896Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Delete.json new file mode 100644 index 000000000000..f16fd481f53b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Get.json new file mode 100644 index 000000000000..c04cd0dce705 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "tags": { + "CostCenter": "RnD" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_List.json new file mode 100644 index 000000000000..d35b645ae58e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "tags": { + "CostCenter": "RnD" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Patch.json new file mode 100644 index 000000000000..7a988f8c9be1 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Patch.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest", + "body": { + "tags": { + "Owner": "superuser" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "tags": { + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Put.json new file mode 100644 index 000000000000..7a988f8c9be1 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/EnvironmentTypes_Put.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "environmentTypeName": "DevTest", + "body": { + "tags": { + "Owner": "superuser" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/devcenters/environmenttypes", + "tags": { + "Owner": "superuser" + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Create.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Create.json new file mode 100644 index 000000000000..6c84c6070d20 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Create.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery", + "body": { + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Delete.json new file mode 100644 index 000000000000..0cc57647da65 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Get.json new file mode 100644 index 000000000000..31b5f9374aef --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_Get.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "StandardGallery" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/StandardGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/StandardGallery", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_List.json new file mode 100644 index 000000000000..5a248e234426 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Galleries_List.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/default", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "provisioningState": "Succeeded", + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/CentralGallery" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/ImageGallery", + "name": "StandardGallery", + "type": "Microsoft.DevCenter/devcenters/galleries", + "properties": { + "galleryResourceId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.Compute/galleries/SharedGallery", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "User1", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ImageVersions_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ImageVersions_Get.json new file mode 100644 index 000000000000..c0bf5785f001 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ImageVersions_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "Win11", + "versionName": "1.0.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/Win11/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/devcenters/galleries/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ImageVersions_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ImageVersions_List.json new file mode 100644 index 000000000000..bc42eb72d7f0 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ImageVersions_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "Win11" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/Win11/1.0.0", + "name": "1.0.0", + "type": "Microsoft.DevCenter/devcenters/galleries/images/versions", + "properties": { + "publishedDate": "2021-12-01T12:45:16.845Z", + "excludeFromLatest": false, + "osDiskImageSizeInGb": 64, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_Get.json new file mode 100644 index 000000000000..2d86a3e413f8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DefaultDevGallery", + "imageName": "ContosoBaseImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DefaultDevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_ListByDevCenter.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_ListByDevCenter.json new file mode 100644 index 000000000000..0e33b9607c88 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_ListByDevCenter.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage2", + "name": "ContosoBaseImage2", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_ListByGallery.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_ListByGallery.json new file mode 100644 index 000000000000..514fc3429967 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Images_ListByGallery.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "devCenterName": "Contoso", + "galleryName": "DevGallery" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage", + "name": "ContosoBaseImage", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Windows 10 Enterprise + OS Optimizations 1909", + "publisher": "MicrosoftWindowsDesktop", + "offer": "windows-ent-cpc", + "sku": "19h2-ent-cpc-os-g2", + "recommendedMachineConfiguration": { + "memory": { + "min": 128, + "max": 256 + }, + "vCPUs": { + "min": 2, + "max": 4 + } + }, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + }, + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/DevGallery/images/ContosoBaseImage2", + "name": "ContosoBaseImage2", + "type": "Microsoft.DevCenter/devcenters/galleries/images", + "properties": { + "description": "Standard Windows Dev/Test image.", + "publisher": "Contoso", + "offer": "Finance", + "sku": "Backend", + "recommendedMachineConfiguration": { + "memory": { + "min": 256, + "max": 512 + }, + "vCPUs": { + "min": 4, + "max": 8 + } + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Delete.json new file mode 100644 index 000000000000..cc14380cdf41 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "eastusnetwork" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Get.json new file mode 100644 index 000000000000..533e9a2d1fd2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded", + "healthCheckStatus": "Passed" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_GetHealthDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_GetHealthDetails.json new file mode 100644 index 000000000000..dde94f615e41 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_GetHealthDetails.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "eastusnetwork" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/eastusnetwork/healthchecks/latest", + "name": "latest", + "type": "Microsoft.DevCenter/networkconnections/healthchecks", + "properties": { + "startDateTime": "2021-07-03T12:43:14Z", + "endDateTime": "2021-07-03T12:43:15Z", + "healthChecks": [ + { + "displayName": "Azure AD device sync", + "endDateTime": "2021-07-03T12:43:14Z", + "startDateTime": "2021-07-03T12:43:15Z", + "status": "Passed" + } + ] + }, + "systemData": { + "createdBy": "System", + "createdByType": "Application", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "System", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListByResourceGroup.json new file mode 100644 index 000000000000..67e376e4048b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListByResourceGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListBySubscription.json new file mode 100644 index 000000000000..51d3d1257543 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListBySubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnection", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListHealthDetails.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListHealthDetails.json new file mode 100644 index 000000000000..a18083aa0a6f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListHealthDetails.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network/healthchecks/latest", + "name": "latest", + "type": "Microsoft.DevCenter/networkconnections/healthchecks", + "properties": { + "startDateTime": "2021-07-03T12:43:14Z", + "endDateTime": "2021-07-03T12:43:15Z", + "healthChecks": [ + { + "displayName": "Azure AD device sync", + "endDateTime": "2021-07-03T12:43:14Z", + "startDateTime": "2021-07-03T12:43:15Z", + "status": "Passed" + } + ] + }, + "systemData": { + "createdBy": "System", + "createdByType": "Application", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "System", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json new file mode 100644 index 000000000000..065548f619f7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "category": "Dev Box Service", + "endpoints": [ + { + "domainName": "devbox.azure.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Intune", + "endpoints": [ + { + "domainName": "login.microsoftonline.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + }, + { + "category": "Cloud PC", + "endpoints": [ + { + "domainName": "rdweb.wvd.microsoft.com", + "endpointDetails": [ + { + "port": 443 + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Patch.json new file mode 100644 index 000000000000..ac137e5b8f34 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Patch.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network", + "body": { + "properties": { + "domainPassword": "New Password value for user" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Put.json new file mode 100644 index 000000000000..11c496eede8e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_Put.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network", + "body": { + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "domainPassword": "Password value for user", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default" + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/networkconnections/uswest3network", + "name": "uswest3network", + "type": "Microsoft.DevCenter/networkconnections", + "properties": { + "domainJoinType": "HybridAzureADJoin", + "domainName": "mydomaincontroller.local", + "domainUsername": "testuser@mydomaincontroller.local", + "networkingResourceGroupName": "NetworkInterfaces", + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ExampleRG/providers/Microsoft.Network/virtualNetworks/ExampleVNet/subnets/default", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_RunHealthChecks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_RunHealthChecks.json new file mode 100644 index 000000000000..bd2ffc9689b6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/NetworkConnections_RunHealthChecks.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "networkConnectionName": "uswest3network" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/{operationId}?api-version={api-version}" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/OperationStatus_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/OperationStatus_Get.json new file mode 100644 index 000000000000..ddefbc2ae22a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/OperationStatus_Get.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "location": "westus3", + "operationId": "3fa1a29d-e807-488d-81d1-f1c5456a08cd" + }, + "responses": { + "200": { + "body": { + "id": "3fa1a29d-e807-488d-81d1-f1c5456a08cd", + "status": "Succeeded", + "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "startTime": "2020-12-01T15:16:29.500Z", + "endTime": "2020-12-01T15:16:55.100Z", + "percentComplete": 100 + } + }, + "202": { + "body": { + "id": "3fa1a29d-e807-488d-81d1-f1c5456a08cd", + "status": "Succeeded", + "resourceId": "/subscriptions/{subscriptionId}/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "startTime": "2020-12-01T15:16:29.500Z", + "endTime": "2020-12-01T15:16:55.100Z", + "percentComplete": 99 + } + }, + "default": { + "body": { + "error": { + "code": "OperationNotFound", + "message": "The requested async operation was not found" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Operations_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Operations_Get.json new file mode 100644 index 000000000000..83b9203bdad7 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Operations_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DevCenter/devcenters/write", + "display": { + "provider": "Microsoft DevTest Center", + "resource": "Microsoft DevTest Center devcenter resource", + "operation": "write" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Delete.json new file mode 100644 index 000000000000..9c490787e09a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "poolName" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Get.json new file mode 100644 index 000000000000..7489b01d1429 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_GetUnhealthyStatus.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_GetUnhealthyStatus.json new file mode 100644 index 000000000000..3d053f67319a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_GetUnhealthyStatus.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Unhealthy", + "healthStatusDetails": [ + { + "code": "NetworkConnectionUnhealthy", + "message": "The Pool's Network Connection is in an unhealthy state. Check the Network Connection's health status for more details." + }, + { + "code": "ImageValidationFailed", + "message": "Image validation has failed. Check the Dev Box Definition's image validation status for more details." + }, + { + "code": "IntuneValidationFailed", + "message": "Intune license validation has failed. The tenant does not have a valid Intune license." + } + ], + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_List.json new file mode 100644 index 000000000000..2be0f9e1dbc6 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Patch.json new file mode 100644 index 000000000000..27d4899c27dd --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Patch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "devBoxDefinitionName": "WebDevBox2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "devBoxDefinitionName": "WebDevBox2", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Put.json new file mode 100644 index 000000000000..42cfbc81912d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_Put.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "body": { + "properties": { + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + } + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Healthy", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/pools/DevPool", + "name": "DevPool", + "type": "Microsoft.DevCenter/pools", + "properties": { + "devBoxDefinitionName": "WebDevBox", + "networkConnectionName": "Network1-westus2", + "licenseType": "Windows_Client", + "localAdministrator": "Enabled", + "stopOnDisconnect": { + "status": "Enabled", + "gracePeriodMinutes": 60 + }, + "healthStatus": "Pending", + "provisioningState": "Created" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_RunHealthChecks.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_RunHealthChecks.json new file mode 100644 index 000000000000..62cdb90c3627 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Pools_RunHealthChecks.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectAllowedEnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectAllowedEnvironmentTypes_Get.json new file mode 100644 index 000000000000..8d861f4b0ac4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectAllowedEnvironmentTypes_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/Contoso/allowedEnvironmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/allowedenvironmenttypes", + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectAllowedEnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectAllowedEnvironmentTypes_List.json new file mode 100644 index 000000000000..f5f64e9ba0f8 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectAllowedEnvironmentTypes_List.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "Contoso" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/Contoso/allowedEnvironmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/allowedenvironmenttypes", + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Delete.json new file mode 100644 index 000000000000..0b9b6d0ddbc4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Get.json new file mode 100644 index 000000000000..d017184bde6b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Get.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_List.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_List.json new file mode 100644 index 000000000000..6bb05df19e30 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_List.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Patch.json new file mode 100644 index 000000000000..1569c07c5993 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Patch.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + }, + "tags": { + "CostCenter": "RnD" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Put.json new file mode 100644 index 000000000000..9d7c564914c2 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/ProjectEnvironmentTypes_Put.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "ContosoProj", + "environmentTypeName": "DevTest", + "body": { + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": {} + } + } + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": {} + } + }, + "tags": { + "CostCenter": "RnD" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/ContosoProj/environmentTypes/DevTest", + "name": "DevTest", + "type": "Microsoft.DevCenter/projects/environmentTypes", + "properties": { + "deploymentTargetId": "/subscriptions/00000000-0000-0000-0000-000000000000", + "status": "Enabled", + "provisioningState": "Succeeded", + "creatorRoleAssignment": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + }, + "userRoleAssignments": { + "e45e3m7c-176e-416a-b466-0c5ec8298f8a": { + "roles": { + "4cbf0b6c-e750-441c-98a7-10da8387e4d6": { + "roleName": "Developer", + "description": "Allows Developer access to project virtual machine resources." + } + } + } + } + }, + "systemData": { + "createdBy": "User1@contoso.com", + "createdByType": "User", + "createdAt": "2020-11-18T18:24:24.818Z", + "lastModifiedBy": "User1@contoso.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:24:24.818Z" + }, + "tags": { + "CostCenter": "RnD" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/identityGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/testidentity1": { + "clientId": "e35621a5-f615-4a20-940e-de8a84b15abc", + "principalId": "2111b8fc-e123-485a-b408-bf1153189494" + } + } + }, + "location": "centralus" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Delete.json new file mode 100644 index 000000000000..be9775626a2e --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Get.json new file mode 100644 index 000000000000..7251a697f18f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Get.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project." + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_ListByResourceGroup.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_ListByResourceGroup.json new file mode 100644 index 000000000000..f89d5584fde4 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_ListByResourceGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myproject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_ListBySubscription.json new file mode 100644 index 000000000000..1cc9bbba9c21 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_ListBySubscription.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/myproject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Patch.json new file mode 100644 index 000000000000..0de2478dd124 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Patch.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "description": "This is my first project." + }, + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "myproject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project. Very exciting.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Put.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Put.json new file mode 100644 index 000000000000..18b7c0ff365b --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_Put.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project." + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_PutWithMaxDevBoxPerUser.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_PutWithMaxDevBoxPerUser.json new file mode 100644 index 000000000000..556ae8adfc3d --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Projects_PutWithMaxDevBoxPerUser.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "body": { + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3 + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "devCenterUri": "https://4c7c8922-78e9-4928-aa6f-75ba59355371-contoso.centralus.devcenter.azure.com", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject", + "name": "DevProject", + "type": "Microsoft.DevCenter/projects", + "properties": { + "devCenterId": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/devcenters/Contoso", + "description": "This is my first project.", + "maxDevBoxesPerUser": 3, + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + }, + "location": "centralus", + "tags": { + "CostCenter": "R&D" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_CreateDailyShutdownPoolSchedule.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_CreateDailyShutdownPoolSchedule.json new file mode 100644 index 000000000000..1b075371df56 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_CreateDailyShutdownPoolSchedule.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "DevProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown", + "body": { + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Accepted" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Delete.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Delete.json new file mode 100644 index 000000000000..31b785e8681a --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Delete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + }, + "204": {} + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Get.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Get.json new file mode 100644 index 000000000000..e1d384f5e491 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Get.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_ListByPool.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_ListByPool.json new file mode 100644 index 000000000000..b518c440086f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_ListByPool.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Patch.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Patch.json new file mode 100644 index 000000000000..0fd6c84cb196 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Schedules_Patch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "resourceGroupName": "rg1", + "projectName": "TestProject", + "poolName": "DevPool", + "scheduleName": "autoShutdown", + "body": { + "properties": { + "time": "18:00" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/TestProject/pools/DevPool/schedules/autoShutdown", + "name": "autoShutdown", + "type": "Microsoft.DevCenter/pools/schedules", + "properties": { + "state": "Enabled", + "type": "StopDevBox", + "timeZone": "America/Los_Angeles", + "frequency": "Daily", + "time": "17:30", + "provisioningState": "Succeeded" + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2020-11-18T18:00:36.993Z", + "lastModifiedBy": "user1", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-11-18T18:30:36.993Z" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01", + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.DevCenter/locations/CENTRALUS/operationStatuses/722e7bc4-60fa-4e6b-864f-d5bf12b9adc4?api-version=2023-04-01" + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Skus_ListBySubscription.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Skus_ListBySubscription.json new file mode 100644 index 000000000000..8e3cdcc9a30f --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Skus_ListBySubscription.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "projects/pools", + "name": "Large", + "tier": "Premium", + "locations": [ + "CentralUS" + ] + }, + { + "resourceType": "projects/pools", + "name": "Medium", + "tier": "Standard", + "locations": [ + "CentralUS" + ] + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Usages_ListByLocation.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Usages_ListByLocation.json new file mode 100644 index 000000000000..3f220c1cc6c5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/examples/Usages_ListByLocation.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "0ac520ee-14c0-480f-b6c9-0a90c58ffff", + "location": "westus" + }, + "responses": { + "200": { + "body": { + "nextLink": null, + "value": [ + { + "currentValue": 2, + "limit": 8, + "unit": "Count", + "name": { + "value": "devcenters" + } + }, + { + "currentValue": 5, + "limit": 30, + "unit": "Count", + "name": { + "value": "projects" + } + } + ] + } + } + } +} diff --git a/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/vdi.json b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/vdi.json new file mode 100644 index 000000000000..3692c5ddacb5 --- /dev/null +++ b/specification/devcenter/resource-manager/Microsoft.DevCenter/stable/2023-04-01/vdi.json @@ -0,0 +1,1771 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01", + "title": "DevCenter", + "description": "DevCenter Management API" + }, + "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.DevCenter/skus": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "SKUs" + ], + "description": "Lists the Microsoft.DevCenter SKUs available in a subscription", + "operationId": "Skus_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/SkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Skus_ListBySubscription": { + "$ref": "./examples/Skus_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools": { + "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": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Pools" + ], + "description": "Lists pools for a project", + "operationId": "Pools_ListByProject", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/PoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Pools_ListByProject": { + "$ref": "./examples/Pools_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}": { + "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": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "get": { + "tags": [ + "Pools" + ], + "description": "Gets a machine pool", + "operationId": "Pools_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Pools_Get": { + "$ref": "./examples/Pools_Get.json" + }, + "Pools_GetUnhealthyStatus": { + "$ref": "./examples/Pools_GetUnhealthyStatus.json" + } + } + }, + "put": { + "tags": [ + "Pools" + ], + "description": "Creates or updates a machine pool", + "operationId": "Pools_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a machine pool", + "required": true, + "schema": { + "$ref": "#/definitions/Pool" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Pools_CreateOrUpdate": { + "$ref": "./examples/Pools_Put.json" + } + } + }, + "patch": { + "tags": [ + "Pools" + ], + "description": "Partially updates a machine pool", + "operationId": "Pools_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a machine pool", + "required": true, + "schema": { + "$ref": "#/definitions/PoolUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Pool" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Pools_Update": { + "$ref": "./examples/Pools_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Pools" + ], + "description": "Deletes a machine pool", + "operationId": "Pools_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Resource has been deleted" + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Pools_Delete": { + "$ref": "./examples/Pools_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/runHealthChecks": { + "post": { + "tags": [ + "Pools" + ], + "description": "Triggers a refresh of the pool status.", + "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": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + } + ], + "operationId": "Pools_RunHealthChecks", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Successfully initiated refresh." + }, + "202": { + "description": "Accepted. Initiating pool status refresh." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Pools_RefreshStatus": { + "$ref": "./examples/Pools_RunHealthChecks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules": { + "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": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Schedules" + ], + "description": "Lists schedules for a pool", + "operationId": "Schedules_ListByPool", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Schedules_ListByPool": { + "$ref": "./examples/Schedules_ListByPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/projects/{projectName}/pools/{poolName}/schedules/{scheduleName}": { + "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": "commonDefinitions.json#/parameters/ProjectNameParameter" + }, + { + "$ref": "#/parameters/PoolNameParameter" + }, + { + "$ref": "#/parameters/ScheduleNameParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Schedules" + ], + "description": "Gets a schedule resource.", + "operationId": "Schedules_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Schedules_GetByPool": { + "$ref": "./examples/Schedules_Get.json" + } + } + }, + "put": { + "tags": [ + "Schedules" + ], + "description": "Creates or updates a Schedule.", + "operationId": "Schedules_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a scheduled task", + "required": true, + "schema": { + "$ref": "#/definitions/Schedule" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Schedules_CreateDailyShutdownPoolSchedule": { + "$ref": "./examples/Schedules_CreateDailyShutdownPoolSchedule.json" + } + } + }, + "patch": { + "tags": [ + "Schedules" + ], + "description": "Partially updates a Scheduled.", + "operationId": "Schedules_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents a scheduled task.", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduleUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Schedule" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Schedules_Update": { + "$ref": "./examples/Schedules_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Schedules" + ], + "description": "Deletes a Scheduled.", + "operationId": "Schedules_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Resource has been deleted" + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Schedules_Delete": { + "$ref": "./examples/Schedules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DevCenter/networkConnections": { + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists network connections in a subscription", + "operationId": "NetworkConnections_ListBySubscription", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListBySubscription": { + "$ref": "./examples/NetworkConnections_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections": { + "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": "commonDefinitions.json#/parameters/TopParameter" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists network connections in a resource group", + "operationId": "NetworkConnections_ListByResourceGroup", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListByResourceGroup": { + "$ref": "./examples/NetworkConnections_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}": { + "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/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Gets a network connection resource", + "operationId": "NetworkConnections_Get", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Get": { + "$ref": "./examples/NetworkConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "Network Connections" + ], + "description": "Creates or updates a Network Connections resource", + "operationId": "NetworkConnections_CreateOrUpdate", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents network connection", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "Accepted. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "201": { + "description": "Created. Operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkConnections_CreateOrUpdate": { + "$ref": "./examples/NetworkConnections_Put.json" + } + } + }, + "patch": { + "tags": [ + "Network Connections" + ], + "description": "Partially updates a Network Connection", + "operationId": "NetworkConnections_Update", + "parameters": [ + { + "in": "body", + "name": "body", + "description": "Represents network connection", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConnectionUpdate" + } + } + ], + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/NetworkConnection" + } + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Update": { + "$ref": "./examples/NetworkConnections_Patch.json" + } + } + }, + "delete": { + "tags": [ + "Network Connections" + ], + "description": "Deletes a Network Connections resource", + "operationId": "NetworkConnections_Delete", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Resource has been deleted" + }, + "202": { + "description": "Accepted. Operation will complete asynchronously." + }, + "204": { + "description": "Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkConnections_Delete": { + "$ref": "./examples/NetworkConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/healthChecks": { + "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": "commonDefinitions.json#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connections" + ], + "description": "Lists health check status details", + "operationId": "NetworkConnections_ListHealthDetails", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/HealthCheckStatusDetailsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkConnections_ListHealthDetails": { + "$ref": "./examples/NetworkConnections_ListHealthDetails.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/healthChecks/latest": { + "get": { + "tags": [ + "Network Connections" + ], + "description": "Gets health check status details.", + "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/NetworkConnectionName" + } + ], + "operationId": "NetworkConnections_GetHealthDetails", + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/HealthCheckStatusDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkConnections_GetHealthDetails": { + "$ref": "./examples/NetworkConnections_GetHealthDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/runHealthChecks": { + "post": { + "tags": [ + "Network Connection" + ], + "description": "Triggers a new health check run. The execution and health check result can be tracked via the network Connection health check details", + "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/NetworkConnectionName" + } + ], + "operationId": "NetworkConnections_RunHealthChecks", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "responses": { + "200": { + "description": "OK. Successfully initiated health check." + }, + "202": { + "description": "Accepted. Initiating health checks." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkConnections_RunHealthChecks": { + "$ref": "./examples/NetworkConnections_RunHealthChecks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DevCenter/networkConnections/{networkConnectionName}/outboundNetworkDependenciesEndpoints": { + "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": "commonDefinitions.json#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/NetworkConnectionName" + } + ], + "get": { + "tags": [ + "Network Connection" + ], + "operationId": "NetworkConnections_ListOutboundNetworkDependenciesEndpoints", + "description": "Lists the endpoints that agents may call as part of Dev Box service administration. These FQDNs should be allowed for outbound access in order for the Dev Box service to function.", + "x-ms-examples": { + "ListOutboundNetworkDependencies": { + "$ref": "./examples/NetworkConnections_ListOutboundNetworkDependenciesEndpoints.json" + } + }, + "responses": { + "200": { + "description": "The operation was successful. The response contains a list of outbound network dependencies.", + "schema": { + "$ref": "#/definitions/OutboundEnvironmentEndpointCollection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "commonDefinitions.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SkuListResult": { + "description": "Results of the Microsoft.DevCenter SKU list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "commonDefinitions.json#/definitions/DevCenterSku" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Pool": { + "description": "A pool of Virtual Machines.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Pool properties", + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolProperties" + } + } + }, + "PoolUpdateProperties": { + "description": "Properties of a Pool. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "devBoxDefinitionName": { + "description": "Name of a Dev Box definition in parent Project of this Pool", + "type": "string" + }, + "networkConnectionName": { + "description": "Name of a Network Connection in parent Project of this Pool", + "type": "string" + }, + "licenseType": { + "description": "Specifies the license type indicating the caller has already acquired licenses for the Dev Boxes that will be created.", + "$ref": "#/definitions/LicenseType" + }, + "localAdministrator": { + "description": "Indicates whether owners of Dev Boxes in this pool are added as local administrators on the Dev Box.", + "$ref": "#/definitions/LocalAdminStatus" + }, + "stopOnDisconnect": { + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "$ref": "#/definitions/StopOnDisconnectConfiguration" + } + } + }, + "PoolProperties": { + "type": "object", + "description": "Properties of a Pool", + "allOf": [ + { + "$ref": "#/definitions/PoolUpdateProperties" + } + ], + "properties": { + "healthStatus": { + "description": "Overall health status of the Pool. Indicates whether or not the Pool is available to create Dev Boxes.", + "$ref": "#/definitions/HealthStatus", + "readOnly": true + }, + "healthStatusDetails": { + "description": "Details on the Pool health status to help diagnose issues. This is only populated when the pool status indicates the pool is in a non-healthy state", + "type": "array", + "items": { + "$ref": "#/definitions/HealthStatusDetail" + }, + "readOnly": true + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "devBoxDefinitionName", + "networkConnectionName", + "licenseType", + "localAdministrator" + ] + }, + "HealthStatus": { + "description": "Health status indicating whether a pool is available to create Dev Boxes.", + "enum": [ + "Unknown", + "Pending", + "Healthy", + "Warning", + "Unhealthy" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "HealthStatusDetail": { + "type": "object", + "description": "Pool health status detail.", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the issue.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A message describing the issue, intended to be suitable for display in a user interface", + "readOnly": true + } + } + }, + "LicenseType": { + "description": "License Types", + "enum": [ + "Windows_Client" + ], + "type": "string", + "x-ms-enum": { + "name": "LicenseType", + "modelAsString": true + } + }, + "LocalAdminStatus": { + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "LocalAdminStatus", + "modelAsString": true + } + }, + "StopOnDisconnectConfiguration": { + "type": "object", + "description": "Stop on disconnect configuration settings for Dev Boxes created in this pool.", + "properties": { + "status": { + "description": "Whether the feature to stop the Dev Box on disconnect once the grace period has lapsed is enabled.", + "$ref": "#/definitions/StopOnDisconnectEnableStatus" + }, + "gracePeriodMinutes": { + "description": "The specified time in minutes to wait before stopping a Dev Box once disconnect is detected.", + "type": "integer", + "format": "int32" + } + } + }, + "StopOnDisconnectEnableStatus": { + "description": "Stop on disconnect enable or disable status. Indicates whether stop on disconnect to is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "StopOnDisconnectEnableStatus", + "modelAsString": true + } + }, + "PoolListResult": { + "description": "Results of the machine pool list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Pool" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "PoolUpdate": { + "description": "The pool properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PoolUpdateProperties", + "description": "Properties of a pool to be updated." + } + } + }, + "ImageReference": { + "type": "object", + "description": "Image reference information", + "properties": { + "id": { + "description": "Image ID, or Image version ID. When Image ID is provided, its latest version will be used.", + "type": "string" + }, + "exactVersion": { + "type": "string", + "readOnly": true, + "description": "The actual version of the image after use. When id references a gallery image latest version, this will indicate the actual version in use." + } + } + }, + "ImageValidationStatus": { + "description": "Image validation status", + "enum": [ + "Unknown", + "Pending", + "Succeeded", + "Failed", + "TimedOut" + ], + "type": "string", + "x-ms-enum": { + "name": "ImageValidationStatus", + "modelAsString": true + } + }, + "ImageValidationErrorDetails": { + "type": "object", + "description": "Image validation error details", + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error." + }, + "message": { + "type": "string", + "description": "A message describing the error." + } + } + }, + "NetworkConnection": { + "type": "object", + "description": "Network related settings", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "Properties of a Network Connection", + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkProperties" + } + } + }, + "NetworkConnectionUpdate": { + "description": "The network connection properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkConnectionUpdateProperties", + "description": "Properties of a network connection resource to be updated." + } + } + }, + "NetworkConnectionUpdateProperties": { + "description": "Properties of network connection. These properties can be updated after the resource has been created.", + "type": "object", + "properties": { + "subnetId": { + "description": "The subnet to attach Virtual Machines to", + "type": "string" + }, + "domainName": { + "description": "Active Directory domain name", + "type": "string" + }, + "organizationUnit": { + "description": "Active Directory domain Organization Unit (OU)", + "type": "string" + }, + "domainUsername": { + "description": "The username of an Active Directory account (user or service account) that has permissions to create computer objects in Active Directory. Required format: admin@contoso.com.", + "type": "string" + }, + "domainPassword": { + "description": "The password for the account used to join domain", + "type": "string", + "x-ms-secret": true + } + } + }, + "NetworkProperties": { + "description": "Network properties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkConnectionUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + }, + "healthCheckStatus": { + "description": "Overall health status of the network connection. Health checks are run on creation, update, and periodically to validate the network connection.", + "$ref": "#/definitions/HealthCheckStatus", + "readOnly": true + }, + "networkingResourceGroupName": { + "description": "The name for resource group where NICs will be placed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "domainJoinType": { + "description": "AAD Join type.", + "$ref": "#/definitions/DomainJoinType", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "subnetId", + "domainJoinType" + ] + }, + "NetworkConnectionListResult": { + "description": "Result of the network connection list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkConnection" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "DomainJoinType": { + "description": "Active Directory join type", + "enum": [ + "HybridAzureADJoin", + "AzureADJoin" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainJoinType", + "modelAsString": true + } + }, + "HealthCheckStatus": { + "description": "Health check status values", + "enum": [ + "Unknown", + "Pending", + "Running", + "Passed", + "Warning", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthCheckStatus", + "modelAsString": true + } + }, + "HealthCheckStatusDetails": { + "description": "Health Check details.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Health check status details properties.", + "$ref": "#/definitions/HealthCheckStatusDetailsProperties" + } + } + }, + "HealthCheckStatusDetailsProperties": { + "description": "Health Check properties.", + "type": "object", + "properties": { + "startDateTime": { + "type": "string", + "description": "Start time of last execution of the health checks.", + "readOnly": true, + "format": "date-time" + }, + "endDateTime": { + "type": "string", + "description": "End time of last execution of the health checks.", + "readOnly": true, + "format": "date-time" + }, + "healthChecks": { + "description": "Details for each health check item.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthCheck" + }, + "x-ms-identifiers": [], + "readOnly": true + } + } + }, + "HealthCheck": { + "description": "An individual health check item", + "type": "object", + "properties": { + "status": { + "description": "The status of the health check item.", + "$ref": "#/definitions/HealthCheckStatus", + "readOnly": true + }, + "displayName": { + "description": "The display name of this health check item.", + "type": "string", + "readOnly": true + }, + "startDateTime": { + "description": "Start time of health check item.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "endDateTime": { + "description": "End time of the health check item.", + "type": "string", + "readOnly": true, + "format": "date-time" + }, + "errorType": { + "description": "The type of error that occurred during this health check.", + "type": "string", + "readOnly": true + }, + "recommendedAction": { + "description": "The recommended action to fix the corresponding error.", + "type": "string", + "readOnly": true + }, + "additionalDetails": { + "description": "Additional details about the health check or the recommended action.", + "type": "string", + "readOnly": true + } + } + }, + "HealthCheckStatusDetailsListResult": { + "description": "Result of the network health check list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthCheckStatusDetails" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "OutboundEnvironmentEndpointCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OutboundEnvironmentEndpoint" + }, + "x-ms-identifiers": [ + "category" + ], + "description": "The collection of outbound network dependency endpoints returned by the listing operation." + }, + "nextLink": { + "type": "string", + "description": "The continuation token." + } + }, + "description": "Values returned by the List operation." + }, + "OutboundEnvironmentEndpoint": { + "type": "object", + "properties": { + "category": { + "type": "string", + "readOnly": true, + "description": "The type of service that the agent connects to." + }, + "endpoints": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EndpointDependency" + }, + "x-ms-identifiers": [ + "domainName" + ], + "description": "The endpoints for this service for which the agent requires outbound access." + } + }, + "description": "A collection of related endpoints from the same service for which the agent requires outbound access." + }, + "EndpointDependency": { + "type": "object", + "properties": { + "domainName": { + "type": "string", + "readOnly": true, + "description": "The domain name of the dependency. Domain names may be fully qualified or may contain a * wildcard." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Human-readable supplemental information about the dependency and when it is applicable." + }, + "endpointDetails": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EndpointDetail" + }, + "description": "The list of connection details for this endpoint." + } + }, + "description": "A domain name and connection details used to access a dependency." + }, + "EndpointDetail": { + "type": "object", + "properties": { + "port": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The port an endpoint is connected to." + } + }, + "description": "Details about the connection between the Batch service and the endpoint." + }, + "Schedule": { + "type": "object", + "description": "Represents a Schedule to execute a task.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "Properties of a Schedule resource", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleProperties" + } + } + }, + "ScheduleUpdate": { + "description": "The schedule properties for partial update. Properties not provided in the update request will not be changed.", + "type": "object", + "allOf": [ + { + "$ref": "commonDefinitions.json#/definitions/TrackedResourceUpdate" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleUpdateProperties", + "description": "Properties of a schedule resource to be updated." + } + } + }, + "ScheduleUpdateProperties": { + "description": "Updatable properties of a Schedule.", + "type": "object", + "properties": { + "type": { + "description": "Supported type this scheduled task represents.", + "$ref": "#/definitions/ScheduledType" + }, + "frequency": { + "description": "The frequency of this scheduled task.", + "$ref": "#/definitions/ScheduledFrequency" + }, + "time": { + "description": "The target time to trigger the action. The format is HH:MM.", + "type": "string" + }, + "timeZone": { + "description": "The IANA timezone id at which the schedule should execute.", + "type": "string" + }, + "state": { + "description": "Indicates whether or not this scheduled task is enabled.", + "$ref": "#/definitions/ScheduleEnableStatus" + } + } + }, + "ScheduleProperties": { + "description": "The Schedule properties defining when and what to execute.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ScheduleUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state of the resource.", + "$ref": "commonDefinitions.json#/definitions/ProvisioningState", + "readOnly": true + } + }, + "required": [ + "type", + "frequency", + "timeZone", + "time" + ] + }, + "ScheduleListResult": { + "description": "Result of the schedule list operation.", + "type": "object", + "properties": { + "value": { + "description": "Current page of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Schedule" + }, + "readOnly": true + }, + "nextLink": { + "description": "URL to get the next set of results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "ScheduledType": { + "description": "The supported types for a scheduled task.", + "enum": [ + "StopDevBox" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledType", + "modelAsString": true + } + }, + "ScheduledFrequency": { + "description": "The frequency of task execution.", + "enum": [ + "Daily" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduledFrequency", + "modelAsString": true + } + }, + "ScheduleEnableStatus": { + "description": "Schedule enable or disable status. Indicates whether the schedule applied to is either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ScheduleEnableStatus", + "modelAsString": true + } + } + }, + "parameters": { + "PoolNameParameter": { + "name": "poolName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the pool.", + "x-ms-parameter-location": "method" + }, + "NetworkConnectionName": { + "name": "networkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Network Connection that can be applied to a Pool.", + "x-ms-parameter-location": "method" + }, + "ScheduleNameParameter": { + "name": "scheduleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the schedule that uniquely identifies it.", + "minLength": 1, + "maxLength": 100, + "pattern": "^[-\\w]+$", + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "description": "The filter to apply to the operation. Example: '$filter=contains(name,'myName').", + "type": "string", + "required": false, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/devcenter/resource-manager/readme.md b/specification/devcenter/resource-manager/readme.md index 34ec3c0cba43..81b370ee0951 100644 --- a/specification/devcenter/resource-manager/readme.md +++ b/specification/devcenter/resource-manager/readme.md @@ -27,20 +27,31 @@ These are the global settings for devcenter. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2023-01 +tag: package-2023-04 ``` +### Tag: package-2023-04 + +These settings apply only when `--tag=package-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-2023-04' +input-file: + - Microsoft.DevCenter/stable/2023-04-01/commonDefinitions.json + - Microsoft.DevCenter/stable/2023-04-01/devcenter.json + - Microsoft.DevCenter/stable/2023-04-01/vdi.json +``` ### Tag: package-preview-2023-01 These settings apply only when `--tag=package-preview-2023-01` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-01' +``` yaml $(tag) == 'package-preview-2023-01' input-file: - Microsoft.DevCenter/preview/2023-01-01-preview/commonDefinitions.json - Microsoft.DevCenter/preview/2023-01-01-preview/devcenter.json - Microsoft.DevCenter/preview/2023-01-01-preview/vdi.json ``` + ### Tag: package-preview-2022-11 These settings apply only when `--tag=package-preview-2022-11` is specified on the command line. From 898ced285d47e889c1f507bf51bb0103a347c666 Mon Sep 17 00:00:00 2001 From: Ashwini Singh <42292682+ashwinisingh01@users.noreply.github.com> Date: Thu, 4 May 2023 01:55:59 -0700 Subject: [PATCH 16/79] CosmosDB Mongo RBAC fix MongoRoleDefinitionType (#23190) * initial fix * address review comments * fix release version s * address gates failure * address gate check failure --- ...osDBMongoDBRoleDefinitionCreateUpdate.json | 2 +- .../CosmosDBMongoDBRoleDefinitionGet.json | 2 +- .../CosmosDBMongoDBRoleDefinitionList.json | 2 +- .../preview/2022-08-15-preview/mongorbac.json | 21 +++++++++++++++---- ...osDBMongoDBRoleDefinitionCreateUpdate.json | 2 +- .../CosmosDBMongoDBRoleDefinitionGet.json | 2 +- .../CosmosDBMongoDBRoleDefinitionList.json | 2 +- .../preview/2022-11-15-preview/mongorbac.json | 21 +++++++++++++++---- ...osDBMongoDBRoleDefinitionCreateUpdate.json | 2 +- .../CosmosDBMongoDBRoleDefinitionGet.json | 2 +- .../CosmosDBMongoDBRoleDefinitionList.json | 2 +- .../preview/2023-03-01-preview/mongorbac.json | 21 +++++++++++++++---- ...osDBMongoDBRoleDefinitionCreateUpdate.json | 2 +- .../CosmosDBMongoDBRoleDefinitionGet.json | 2 +- .../CosmosDBMongoDBRoleDefinitionList.json | 2 +- .../stable/2022-08-15/mongorbac.json | 21 +++++++++++++++---- ...osDBMongoDBRoleDefinitionCreateUpdate.json | 2 +- .../CosmosDBMongoDBRoleDefinitionGet.json | 2 +- .../CosmosDBMongoDBRoleDefinitionList.json | 2 +- .../stable/2022-11-15/mongorbac.json | 21 +++++++++++++++---- 20 files changed, 100 insertions(+), 35 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json index e366acc5350f..2aa08184cd12 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json @@ -38,7 +38,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongoDbRoleDefinitionId", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json index 62f9817482ff..fb6ddae6305d 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json @@ -15,7 +15,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json index ef16a7179551..0dc78f38d6fa 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json @@ -15,7 +15,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/mongorbac.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/mongorbac.json index d54d37477a2a..9a8a45eb166d 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/mongorbac.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-08-15-preview/mongorbac.json @@ -406,15 +406,28 @@ "description": "A user-friendly name for the Role Definition. Must be unique for the database account." }, "type": { - "type": "string", + "type": "integer", + "format": "int64", "enum": [ - "BuiltInRole", - "CustomRole" + 0, + 1 ], "description": "Indicates whether the Role Definition was built-in or user created.", "x-ms-enum": { "name": "MongoRoleDefinitionType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": 0, + "description": "The BuiltInRole", + "name": "BuiltInRole" + }, + { + "value": 1, + "description": "The CustomRole", + "name": "CustomRole" + } + ] } }, "databaseName": { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json index f7060c6a4a81..075a064febbc 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json @@ -38,7 +38,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongoDbRoleDefinitionId", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json index ae770a872eb5..56314f08ed43 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json @@ -15,7 +15,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json index 730bc6b3810c..0b3f1fb39ecf 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/examples/CosmosDBMongoDBRoleDefinitionList.json @@ -15,7 +15,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/mongorbac.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/mongorbac.json index e51e048f093b..47e88ae0b74d 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/mongorbac.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2022-11-15-preview/mongorbac.json @@ -406,15 +406,28 @@ "description": "A user-friendly name for the Role Definition. Must be unique for the database account." }, "type": { - "type": "string", + "type": "integer", + "format": "int64", "enum": [ - "BuiltInRole", - "CustomRole" + 0, + 1 ], "description": "Indicates whether the Role Definition was built-in or user created.", "x-ms-enum": { "name": "MongoRoleDefinitionType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": 0, + "description": "The BuiltInRole", + "name": "BuiltInRole" + }, + { + "value": 1, + "description": "The CustomRole", + "name": "CustomRole" + } + ] } }, "databaseName": { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json index ca4e6cd6cfce..f3e6f534e80f 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json @@ -38,7 +38,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongoDbRoleDefinitionId", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json index 4215339e9a80..931f6bfb652e 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionGet.json @@ -15,7 +15,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionList.json index 98d410fea065..8efc5919d9a4 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionList.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/examples/CosmosDBMongoDBRoleDefinitionList.json @@ -15,7 +15,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/mongorbac.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/mongorbac.json index ed59bf2c730a..d58ba07e507d 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/mongorbac.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2023-03-01-preview/mongorbac.json @@ -406,15 +406,28 @@ "description": "A user-friendly name for the Role Definition. Must be unique for the database account." }, "type": { - "type": "string", + "type": "integer", + "format": "int64", "enum": [ - "BuiltInRole", - "CustomRole" + 0, + 1 ], "description": "Indicates whether the Role Definition was built-in or user created.", "x-ms-enum": { "name": "MongoRoleDefinitionType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": 0, + "description": "The BuiltInRole", + "name": "BuiltInRole" + }, + { + "value": 1, + "description": "The CustomRole", + "name": "CustomRole" + } + ] } }, "databaseName": { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json index 0ce1c04fbda3..0b54ba2bd82c 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json @@ -38,7 +38,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongoDbRoleDefinitionId", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionGet.json index 951811b18b26..6830a213123b 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionGet.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionGet.json @@ -15,7 +15,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionList.json index c9cb4dd40aa1..4f2467ff6603 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionList.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/examples/CosmosDBMongoDBRoleDefinitionList.json @@ -15,7 +15,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/mongorbac.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/mongorbac.json index 698de3d93d1a..d55f900d70a2 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/mongorbac.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-08-15/mongorbac.json @@ -406,15 +406,28 @@ "description": "A user-friendly name for the Role Definition. Must be unique for the database account." }, "type": { - "type": "string", + "type": "integer", + "format": "int64", "enum": [ - "BuiltInRole", - "CustomRole" + 0, + 1 ], "description": "Indicates whether the Role Definition was built-in or user created.", "x-ms-enum": { "name": "MongoRoleDefinitionType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": 0, + "description": "The BuiltInRole", + "name": "BuiltInRole" + }, + { + "value": 1, + "description": "The CustomRole", + "name": "CustomRole" + } + ] } }, "databaseName": { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json index be44dbc85218..429078331507 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionCreateUpdate.json @@ -38,7 +38,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongoDbRoleDefinitionId", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionGet.json index 23f6c4c4d47a..c4f62f7fb0c0 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionGet.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionGet.json @@ -15,7 +15,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionList.json index bb7fc8d6fea8..5066953f948c 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionList.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/examples/CosmosDBMongoDBRoleDefinitionList.json @@ -15,7 +15,7 @@ "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions", "properties": { "roleName": "myRoleName", - "type": "CustomRole", + "type": 1, "databaseName": "sales", "privileges": [ { diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/mongorbac.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/mongorbac.json index 8d8f0e7792e9..763e58057c26 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/mongorbac.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2022-11-15/mongorbac.json @@ -406,15 +406,28 @@ "description": "A user-friendly name for the Role Definition. Must be unique for the database account." }, "type": { - "type": "string", + "type": "integer", + "format": "int64", "enum": [ - "BuiltInRole", - "CustomRole" + 0, + 1 ], "description": "Indicates whether the Role Definition was built-in or user created.", "x-ms-enum": { "name": "MongoRoleDefinitionType", - "modelAsString": false + "modelAsString": false, + "values": [ + { + "value": 0, + "description": "The BuiltInRole", + "name": "BuiltInRole" + }, + { + "value": 1, + "description": "The CustomRole", + "name": "CustomRole" + } + ] } }, "databaseName": { From 529aaf1b21eb8f787c0bc6956596d66d7773ea05 Mon Sep 17 00:00:00 2001 From: meydand Date: Thu, 4 May 2023 11:57:18 +0300 Subject: [PATCH 17/79] [Hub Generated] Review request for Microsoft.Insights to add version preview/2023-03-15-preview (#22993) * Adds base for updating Microsoft.Insights from version preview/2022-08-01-preview to version 2023-03-15-preview * Updates readme * Updates API version in new specs and examples * New api version - 2023-03-15-preview * Fix Readme * remove duplications from autorest readme --------- Co-authored-by: meydand Co-authored-by: Meydan Dayan --- .../createOrUpdateScheduledQueryRule.json | 209 +++++ ...UpdateScheduledQueryRuleResourceGroup.json | 167 ++++ ...rUpdateScheduledQueryRuleSubscription.json | 218 +++++ .../examples/deleteScheduledQueryRule.json | 12 + .../examples/getScheduledQueryRule.json | 79 ++ ...istScheduledQueryRulesByResourceGroup.json | 137 +++ ...listScheduledQueryRulesBySubscription.json | 136 +++ .../examples/patchScheduledQueryRule.json | 70 ++ .../scheduledQueryRule_API.json | 853 ++++++++++++++++++ .../monitor/resource-manager/readme.md | 4 +- 10 files changed, 1883 insertions(+), 2 deletions(-) create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRule.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRuleResourceGroup.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRuleSubscription.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/deleteScheduledQueryRule.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/getScheduledQueryRule.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/listScheduledQueryRulesByResourceGroup.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/listScheduledQueryRulesBySubscription.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/patchScheduledQueryRule.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRule.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRule.json new file mode 100644 index 000000000000..5f611938ccbf --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRule.json @@ -0,0 +1,209 @@ +{ + "parameters": { + "subscriptionId": "dd4bfc94-a096-412b-9c43-4bd13e35afbc", + "resourceGroupName": "QueryResourceGroupName", + "ruleName": "perf", + "api-version": "2023-03-15-preview", + "parameters": { + "location": "eastus", + "properties": { + "description": "Performance rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Perf | where ObjectName == \"Processor\"", + "timeAggregation": "Average", + "metricMeasureColumn": "% Processor Time", + "resourceIdColumn": "resourceId", + "dimensions": [ + { + "name": "ComputerIp", + "operator": "Exclude", + "values": [ + "192.168.1.1" + ] + }, + { + "name": "OSType", + "operator": "Include", + "values": [ + "*" + ] + } + ], + "operator": "GreaterThan", + "threshold": 70, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", + "name": "perf", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Performance rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Perf | where ObjectName == \"Processor\"", + "timeAggregation": "Average", + "metricMeasureColumn": "% Processor Time", + "resourceIdColumn": "resourceId", + "dimensions": [ + { + "name": "ComputerIp", + "operator": "Exclude", + "values": [ + "192.168.1.1" + ] + }, + { + "name": "OSType", + "operator": "Include", + "values": [ + "*" + ] + } + ], + "operator": "GreaterThan", + "threshold": 70, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", + "name": "perf", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Performance rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Perf | where ObjectName == \"Processor\"", + "timeAggregation": "Average", + "metricMeasureColumn": "% Processor Time", + "resourceIdColumn": "resourceId", + "dimensions": [ + { + "name": "ComputerIp", + "operator": "Exclude", + "values": [ + "192.168.1.1" + ] + }, + { + "name": "OSType", + "operator": "Include", + "values": [ + "*" + ] + } + ], + "operator": "GreaterThan", + "threshold": 70, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRuleResourceGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRuleResourceGroup.json new file mode 100644 index 000000000000..932a5affb84f --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRuleResourceGroup.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "dd4bfc94-a096-412b-9c43-4bd13e35afbc", + "resourceGroupName": "QueryResourceGroupName", + "ruleName": "heartbeat", + "api-version": "2023-03-15-preview", + "parameters": { + "location": "eastus", + "properties": { + "description": "Health check rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Heartbeat", + "timeAggregation": "Count", + "dimensions": [], + "operator": "GreaterThan", + "threshold": 360, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat", + "name": "heartbeat", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Health check rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Heartbeat", + "timeAggregation": "Count", + "dimensions": [], + "operator": "GreaterThan", + "threshold": 360, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat", + "name": "heartbeat", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Health check rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Heartbeat", + "timeAggregation": "Count", + "dimensions": [], + "operator": "GreaterThan", + "threshold": 360, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRuleSubscription.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRuleSubscription.json new file mode 100644 index 000000000000..033e5479132d --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/createOrUpdateScheduledQueryRuleSubscription.json @@ -0,0 +1,218 @@ +{ + "parameters": { + "subscriptionId": "dd4bfc94-a096-412b-9c43-4bd13e35afbc", + "resourceGroupName": "QueryResourceGroupName", + "ruleName": "perf", + "api-version": "2023-03-15-preview", + "parameters": { + "location": "eastus", + "properties": { + "description": "Performance rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Perf | where ObjectName == \"Processor\"", + "timeAggregation": "Average", + "metricMeasureColumn": "% Processor Time", + "resourceIdColumn": "resourceId", + "dimensions": [ + { + "name": "ComputerIp", + "operator": "Exclude", + "values": [ + "192.168.1.1" + ] + }, + { + "name": "OSType", + "operator": "Include", + "values": [ + "*" + ] + } + ], + "operator": "GreaterThan", + "threshold": 70, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", + "name": "perf", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Performance rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Perf | where ObjectName == \"Processor\"", + "timeAggregation": "Average", + "metricMeasureColumn": "% Processor Time", + "resourceIdColumn": "resourceId", + "dimensions": [ + { + "name": "ComputerIp", + "operator": "Exclude", + "values": [ + "192.168.1.1" + ] + }, + { + "name": "OSType", + "operator": "Include", + "values": [ + "*" + ] + } + ], + "operator": "GreaterThan", + "threshold": 70, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", + "name": "perf", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Performance rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Perf | where ObjectName == \"Processor\"", + "timeAggregation": "Average", + "metricMeasureColumn": "% Processor Time", + "resourceIdColumn": "resourceId", + "dimensions": [ + { + "name": "ComputerIp", + "operator": "Exclude", + "values": [ + "192.168.1.1" + ] + }, + { + "name": "OSType", + "operator": "Include", + "values": [ + "*" + ] + } + ], + "operator": "GreaterThan", + "threshold": 70, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/deleteScheduledQueryRule.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/deleteScheduledQueryRule.json new file mode 100644 index 000000000000..482cca65865f --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/deleteScheduledQueryRule.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "dd4bfc94-a096-412b-9c43-4bd13e35afbc", + "resourceGroupName": "QueryResourceGroupName", + "ruleName": "heartbeat", + "api-version": "2023-03-15-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/getScheduledQueryRule.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/getScheduledQueryRule.json new file mode 100644 index 000000000000..9f5119ce5e67 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/getScheduledQueryRule.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "dd4bfc94-a096-412b-9c43-4bd13e35afbc", + "resourceGroupName": "QueryResourceGroupName", + "ruleName": "perf", + "api-version": "2023-03-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", + "name": "perf", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Performance rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1/providers/Microsoft.Compute/virtualMachines/vm1" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Perf | where ObjectName == \"Processor\"", + "timeAggregation": "Average", + "metricMeasureColumn": "% Processor Time", + "resourceIdColumn": "resourceId", + "dimensions": [ + { + "name": "ComputerIp", + "operator": "Exclude", + "values": [ + "192.168.1.1" + ] + }, + { + "name": "OSType", + "operator": "Include", + "values": [ + "*" + ] + } + ], + "operator": "GreaterThan", + "threshold": 70, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/listScheduledQueryRulesByResourceGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/listScheduledQueryRulesByResourceGroup.json new file mode 100644 index 000000000000..008015356013 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/listScheduledQueryRulesByResourceGroup.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "subscriptionId": "dd4bfc94-a096-412b-9c43-4bd13e35afbc", + "resourceGroupName": "QueryResourceGroupName", + "api-version": "2023-03-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", + "name": "perf", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Performance rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Perf | where ObjectName == \"Processor\"", + "timeAggregation": "Average", + "metricMeasureColumn": "% Processor Time", + "resourceIdColumn": "resourceId", + "dimensions": [ + { + "name": "ComputerIp", + "operator": "Exclude", + "values": [ + "192.168.1.1" + ] + }, + { + "name": "OSType", + "operator": "Include", + "values": [ + "*" + ] + } + ], + "operator": "GreaterThan", + "threshold": 70, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + }, + { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat", + "name": "heartbeat", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Health check rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147/resourceGroups/scopeResourceGroup1" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Heartbeat", + "timeAggregation": "Count", + "dimensions": [], + "operator": "GreaterThan", + "threshold": 360, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/listScheduledQueryRulesBySubscription.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/listScheduledQueryRulesBySubscription.json new file mode 100644 index 000000000000..298802f70413 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/listScheduledQueryRulesBySubscription.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "subscriptionId": "dd4bfc94-a096-412b-9c43-4bd13e35afbc", + "api-version": "2023-03-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/perf", + "name": "perf", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Performance rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Perf | where ObjectName == \"Processor\"", + "timeAggregation": "Average", + "metricMeasureColumn": "% Processor Time", + "resourceIdColumn": "resourceId", + "dimensions": [ + { + "name": "ComputerIp", + "operator": "Exclude", + "values": [ + "192.168.1.1" + ] + }, + { + "name": "OSType", + "operator": "Include", + "values": [ + "*" + ] + } + ], + "operator": "GreaterThan", + "threshold": 70, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + }, + { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/MyResourceGroupName2/providers/microsoft.insights/scheduledqueryrules/heartbeat", + "name": "heartbeat", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Health check rule", + "severity": 4, + "enabled": true, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Heartbeat", + "timeAggregation": "Count", + "dimensions": [], + "operator": "GreaterThan", + "threshold": 360, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/patchScheduledQueryRule.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/patchScheduledQueryRule.json new file mode 100644 index 000000000000..e1f86126549f --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/examples/patchScheduledQueryRule.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "dd4bfc94-a096-412b-9c43-4bd13e35afbc", + "resourceGroupName": "QueryResourceGroupName", + "ruleName": "heartbeat", + "api-version": "2023-03-15-preview", + "parameters": { + "properties": { + "enabled": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/dd4bfc94-a096-412b-9c43-4bd13e35afbc/resourcegroups/QueryResourceGroupName/providers/microsoft.insights/scheduledqueryrules/heartbeat", + "name": "heartbeat", + "type": "microsoft.insights/scheduledqueryrules", + "location": "eastus", + "tags": {}, + "properties": { + "description": "Health check rule", + "severity": 4, + "enabled": false, + "evaluationFrequency": "PT5M", + "scopes": [ + "/subscriptions/aaf177ed-1330-a9f2-80ea-fd3d7783b147" + ], + "targetResourceTypes": [ + "Microsoft.Compute/virtualMachines" + ], + "windowSize": "PT10M", + "criteria": { + "allOf": [ + { + "query": "Heartbeat", + "timeAggregation": "Count", + "dimensions": [], + "operator": "GreaterThan", + "threshold": 360, + "failingPeriods": { + "numberOfEvaluationPeriods": 1, + "minFailingPeriodsToAlert": 1 + } + } + ] + }, + "muteActionsDuration": "PT30M", + "actions": { + "actionGroups": [ + "/subscriptions/1cf177ed-1330-4692-80ea-fd3d7783b147/resourcegroups/sqrapi/providers/microsoft.insights/actiongroups/myactiongroup" + ], + "customProperties": { + "key11": "value11", + "key12": "value12" + } + }, + "ruleResolveConfiguration": { + "autoResolved": true, + "timeToResolve": "PT10M" + }, + "isWorkspaceAlertsStorageConfigured": true, + "checkWorkspaceAlertsStorageConfigured": true, + "skipQueryValidation": true + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json new file mode 100644 index 000000000000..4818a72ab5eb --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-03-15-preview/scheduledQueryRule_API.json @@ -0,0 +1,853 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-03-15-preview", + "title": "Scheduled Query Rules API", + "description": "Azure Monitor client to create/update/delete Scheduled Query 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}/providers/Microsoft.Insights/scheduledQueryRules": { + "get": { + "tags": [ + "ScheduledQueryRules" + ], + "description": "Retrieve a scheduled query rule definitions in a subscription.", + "operationId": "ScheduledQueryRules_ListBySubscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for a list of scheduled query rules", + "schema": { + "$ref": "#/definitions/ScheduledQueryRuleResourceCollection" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/ErrorContract" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List scheduled query rules by subscription": { + "$ref": "./examples/listScheduledQueryRulesBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules": { + "get": { + "tags": [ + "ScheduledQueryRules" + ], + "description": "Retrieve scheduled query rule definitions in a resource group.", + "operationId": "ScheduledQueryRules_ListByResourceGroup", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for a list of scheduled query rules", + "schema": { + "$ref": "#/definitions/ScheduledQueryRuleResourceCollection" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/ErrorContract" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List scheduled query rules by resource group": { + "$ref": "./examples/listScheduledQueryRulesByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName}": { + "get": { + "tags": [ + "ScheduledQueryRules" + ], + "description": "Retrieve an scheduled query rule definition.", + "operationId": "ScheduledQueryRules_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successful request to get a scheduled query rule", + "schema": { + "$ref": "#/definitions/ScheduledQueryRuleResource" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/ErrorContract" + } + } + }, + "x-ms-examples": { + "Get a scheduled query rule for single resource": { + "$ref": "./examples/getScheduledQueryRule.json" + } + } + }, + "put": { + "tags": [ + "ScheduledQueryRules" + ], + "description": "Creates or updates a scheduled query rule.", + "operationId": "ScheduledQueryRules_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduledQueryRuleResource" + }, + "description": "The parameters of the rule to create or update." + } + ], + "responses": { + "200": { + "description": "Successful request to update a scheduled query rule", + "schema": { + "$ref": "#/definitions/ScheduledQueryRuleResource" + } + }, + "201": { + "description": "Created a scheduled query rule", + "schema": { + "$ref": "#/definitions/ScheduledQueryRuleResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorContract" + } + } + }, + "x-ms-examples": { + "Create or update a scheduled query rule for Single Resource": { + "$ref": "./examples/createOrUpdateScheduledQueryRule.json" + }, + "Create or update a scheduled query rule on Resource group(s)": { + "$ref": "./examples/createOrUpdateScheduledQueryRuleResourceGroup.json" + }, + "Create or update a scheduled query rule on Subscription ": { + "$ref": "./examples/createOrUpdateScheduledQueryRuleSubscription.json" + } + } + }, + "patch": { + "tags": [ + "ScheduledQueryRules" + ], + "description": "Update a scheduled query rule.", + "operationId": "ScheduledQueryRules_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScheduledQueryRuleResourcePatch" + }, + "description": "The parameters of the rule to update." + } + ], + "responses": { + "200": { + "description": "Successful request to update a scheduled query rule", + "schema": { + "$ref": "#/definitions/ScheduledQueryRuleResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorContract" + } + } + }, + "x-ms-examples": { + "Create or update a scheduled query rule": { + "$ref": "./examples/patchScheduledQueryRule.json" + } + } + }, + "delete": { + "tags": [ + "ScheduledQueryRules" + ], + "description": "Deletes a scheduled query rule.", + "operationId": "ScheduledQueryRules_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/RuleNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorContract" + } + }, + "200": { + "description": "Successful request to delete a scheduled query rule" + }, + "204": { + "description": "No content: the request was successful, but the response is empty" + } + }, + "x-ms-examples": { + "Delete a scheduled query rule": { + "$ref": "./examples/deleteScheduledQueryRule.json" + } + } + } + } + }, + "definitions": { + "Actions": { + "type": "object", + "description": "Actions to invoke when the alert fires.", + "properties": { + "actionGroups": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Action Group resource Ids to invoke when the alert fires." + }, + "customProperties": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "The dictionary of custom properties to include with the post operation. These data are appended to the alert payload." + }, + "description": "The properties of an alert payload." + }, + "actionProperties": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "The dictionary of action properties to include with the post operation. This data customizes the actions." + }, + "description": "The properties of an action properties." + } + } + }, + "RuleResolveConfiguration": { + "type": "object", + "description": "TBD. Relevant only for rules of the kind LogAlert.", + "properties": { + "autoResolved": { + "type": "boolean", + "description": "The flag that indicates whether or not to auto resolve a fired alert." + }, + "timeToResolve": { + "type": "string", + "format": "duration", + "description": "The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented in ISO 8601 duration format." + } + } + }, + "ScheduledQueryRuleProperties": { + "type": "object", + "properties": { + "createdWithApiVersion": { + "type": "string", + "readOnly": true, + "description": "The api-version used when creating this alert rule" + }, + "isLegacyLogAnalyticsRule": { + "type": "boolean", + "readOnly": true, + "description": "True if alert rule is legacy Log Analytic rule" + }, + "description": { + "type": "string", + "description": "The description of the scheduled query rule." + }, + "displayName": { + "type": "string", + "description": "The display name of the alert rule" + }, + "severity": { + "type": "integer", + "format": "int64", + "description": "Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only for rules of the kind LogAlert.", + "enum": [ + 0, + 1, + 2, + 3, + 4 + ], + "x-ms-enum": { + "name": "AlertSeverity", + "modelAsString": true + } + }, + "enabled": { + "type": "boolean", + "description": "The flag which indicates whether this scheduled query rule is enabled. Value should be true or false" + }, + "scopes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of resource id's that this scheduled query rule is scoped to." + }, + "evaluationFrequency": { + "type": "string", + "format": "duration", + "description": "How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant and required only for rules of the kind LogAlert." + }, + "windowSize": { + "type": "string", + "format": "duration", + "description": "The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). Relevant and required only for rules of the kind LogAlert." + }, + "overrideQueryTimeRange": { + "type": "string", + "format": "duration", + "description": "If specified then overrides the query time range (default is WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert." + }, + "targetResourceTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of resource type of the target resource(s) on which the alert is created/updated. For example if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of the kind LogAlert" + }, + "criteria": { + "$ref": "#/definitions/ScheduledQueryRuleCriteria", + "description": "The rule criteria that defines the conditions of the scheduled query rule." + }, + "muteActionsDuration": { + "type": "string", + "format": "duration", + "description": "Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. Relevant only for rules of the kind LogAlert." + }, + "actions": { + "type": "object", + "$ref": "#/definitions/Actions", + "description": "Actions to invoke when the alert fires." + }, + "isWorkspaceAlertsStorageConfigured": { + "type": "boolean", + "readOnly": true, + "description": "The flag which indicates whether this scheduled query rule has been configured to be stored in the customer's storage. The default is false." + }, + "checkWorkspaceAlertsStorageConfigured": { + "type": "boolean", + "description": "The flag which indicates whether this scheduled query rule should be stored in the customer's storage. The default is false. Relevant only for rules of the kind LogAlert." + }, + "skipQueryValidation": { + "type": "boolean", + "description": "The flag which indicates whether the provided query should be validated or not. The default is false. Relevant only for rules of the kind LogAlert." + }, + "autoMitigate": { + "type": "boolean", + "description": "The flag that indicates whether the alert should be automatically resolved or not. The default is true. Relevant only for rules of the kind LogAlert." + }, + "ruleResolveConfiguration": { + "type": "object", + "$ref": "#/definitions/RuleResolveConfiguration", + "description": "Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert." + } + }, + "description": "scheduled query rule Definition" + }, + "ScheduledQueryRuleResource": { + "type": "object", + "required": [ + "properties", + "location" + ], + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" + }, + "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\"" + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "kind": { + "type": "string", + "description": "Indicates the type of scheduled query rule. The default is LogAlert.", + "enum": [ + "LogAlert", + "LogToMetric" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "The etag field is *not* required. If it is provided in the response body, it must 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. " + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData", + "description": "SystemData of ScheduledQueryRule.", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduledQueryRuleProperties", + "description": "The rule properties of the resource.", + "required": [ + "enabled", + "criteria", + "scopes" + ] + } + }, + "description": "The scheduled query rule resource.", + "x-ms-azure-resource": true + }, + "ScheduledQueryRuleResourcePatch": { + "type": "object", + "properties": { + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduledQueryRuleProperties", + "description": "The scheduled query rule properties of the resource." + } + }, + "description": "The scheduled query rule resource for patch operations." + }, + "ScheduledQueryRuleResourceCollection": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ScheduledQueryRuleResource" + }, + "description": "The values for the scheduled query rule resources." + }, + "nextLink": { + "description": "Provides the link to retrieve the next set of elements.", + "type": "string", + "readOnly": true + } + }, + "description": "Represents a collection of scheduled query rule resources." + }, + "ScheduledQueryRuleCriteria": { + "type": "object", + "description": "The rule criteria that defines the conditions of the scheduled query rule.", + "properties": { + "allOf": { + "type": "array", + "description": "A list of conditions to evaluate against the specified scopes", + "items": { + "$ref": "#/definitions/Condition" + }, + "x-ms-identifiers": [] + } + } + }, + "Condition": { + "type": "object", + "description": "A condition of the scheduled query rule.", + "properties": { + "query": { + "type": "string", + "description": "Log query alert" + }, + "timeAggregation": { + "type": "string", + "description": "Aggregation type. Relevant and required only for rules of the kind LogAlert.", + "enum": [ + "Count", + "Average", + "Minimum", + "Maximum", + "Total" + ], + "x-ms-enum": { + "name": "timeAggregation", + "modelAsString": true + } + }, + "metricMeasureColumn": { + "type": "string", + "description": "The column containing the metric measure number. Relevant only for rules of the kind LogAlert." + }, + "resourceIdColumn": { + "type": "string", + "description": "The column containing the resource id. The content of the column must be a uri formatted as resource id. Relevant only for rules of the kind LogAlert." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "description": "List of Dimensions conditions", + "x-ms-identifiers": [] + }, + "operator": { + "type": "string", + "enum": [ + "Equals", + "GreaterThan", + "GreaterThanOrEqual", + "LessThan", + "LessThanOrEqual" + ], + "x-ms-enum": { + "name": "conditionOperator", + "modelAsString": true + }, + "description": "The criteria operator. Relevant and required only for rules of the kind LogAlert." + }, + "threshold": { + "type": "number", + "format": "double", + "description": "the criteria threshold value that activates the alert. Relevant and required only for rules of the kind LogAlert." + }, + "failingPeriods": { + "type": "object", + "description": "The minimum number of violations required within the selected lookback time window required to raise an alert. Relevant only for rules of the kind LogAlert.", + "properties": { + "numberOfEvaluationPeriods": { + "type": "integer", + "format": "int64", + "default": 1, + "description": "The number of aggregated lookback points. The lookback time window is calculated based on the aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1" + }, + "minFailingPeriodsToAlert": { + "type": "integer", + "format": "int64", + "default": 1, + "description": "The number of violations to trigger an alert. Should be smaller or equal to numberOfEvaluationPeriods. Default value is 1" + } + } + }, + "metricName": { + "type": "string", + "description": "The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric." + } + } + }, + "Dimension": { + "type": "object", + "description": "Dimension splitting and filtering definition", + "properties": { + "name": { + "type": "string", + "description": "Name of the dimension" + }, + "operator": { + "type": "string", + "description": "Operator for dimension values", + "enum": [ + "Include", + "Exclude" + ], + "x-ms-enum": { + "name": "dimensionOperator", + "modelAsString": true + } + }, + "values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of dimension values" + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "ErrorContract": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "#/definitions/ErrorResponseDetails" + } + } + }, + "ErrorResponseDetails": { + "title": "Error Response", + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)", + "type": "object", + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The error code." + }, + "message": { + "readOnly": true, + "type": "string", + "description": "The error message." + }, + "target": { + "readOnly": true, + "type": "string", + "description": "The error target." + }, + "details": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorResponseDetails" + }, + "x-ms-identifiers": [ + "message", + "target" + ], + "description": "The error details." + }, + "additionalInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ErrorResponseAdditionalInfo" + }, + "x-ms-identifiers": [], + "description": "The error additional info." + } + } + }, + "ErrorResponseAdditionalInfo": { + "type": "object", + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The additional info type." + }, + "info": { + "readOnly": true, + "type": "object", + "description": "The additional info." + } + }, + "description": "The resource management error additional info." + }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "Type of managed service identity.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentityProperties" + } + } + }, + "required": [ + "type" + ], + "type": "object", + "description": "Identity for the resource." + }, + "UserIdentityProperties": { + "type": "object", + "description": "User assigned identity properties.", + "properties": { + "principalId": { + "readOnly": true, + "description": "The principal id of user assigned identity.", + "type": "string" + }, + "clientId": { + "readOnly": true, + "description": "The client id of user assigned identity.", + "type": "string" + } + } + } + }, + "parameters": { + "RuleNameParameter": { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 1a6699c67241..51f6f7a171d7 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -93,7 +93,7 @@ input-file: - Microsoft.Insights/stable/2021-05-01/metrics_API.json - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/preview/2022-08-01-preview/scheduledQueryRule_API.json +- Microsoft.Insights/preview/2023-03-15-preview/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 @@ -174,7 +174,7 @@ input-file: - Microsoft.Insights/stable/2021-05-01/metrics_API.json - Microsoft.Insights/stable/2019-03-01/metricBaselines_API.json - Microsoft.Insights/stable/2018-03-01/metricAlert_API.json -- Microsoft.Insights/preview/2022-08-01-preview/scheduledQueryRule_API.json +- Microsoft.Insights/preview/2023-03-15-preview/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 From a39da5e523a16cec60c9712428020c90442cc4d2 Mon Sep 17 00:00:00 2001 From: guy-microsoft <50947884+guy-microsoft@users.noreply.github.com> Date: Thu, 4 May 2023 12:42:12 +0300 Subject: [PATCH 18/79] Fix example (#23586) --- .../examples/ResourceDeletionDelete.json | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2022-08-08/examples/ResourceDeletionDelete.json b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2022-08-08/examples/ResourceDeletionDelete.json index 6309ec912e8d..cbb9e490ba07 100644 --- a/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2022-08-08/examples/ResourceDeletionDelete.json +++ b/specification/healthbot/resource-manager/Microsoft.HealthBot/stable/2022-08-08/examples/ResourceDeletionDelete.json @@ -6,8 +6,20 @@ "botName": "samplebotname" }, "responses": { - "200": {}, - "202": {}, - "204": {} + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Healthbot/locations/eastus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f0f?api-version=2022-08-08" + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Healthbot/locations/eastus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f0f?api-version=2022-08-08" + } + }, + "204": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-123456789098/providers/Microsoft.Healthbot/locations/eastus/operationResults/742bef43-608b-4b58-ba96-6f7a32ec5f0f?api-version=2022-08-08" + } + } } } From b40c1b9c2d79cd0eb8046337fa44f22e44d9e895 Mon Sep 17 00:00:00 2001 From: RenzoPrettoMS <113057297+RenzoPrettoMS@users.noreply.github.com> Date: Thu, 4 May 2023 09:15:44 -0700 Subject: [PATCH 19/79] [Hub Generated] Review request for Microsoft.Chaos to add version preview/2023-04-15-preview (#23744) * chore: update capability type and fix reference * chore: update to fix lint issues --- .../types/capabilityTypes.json | 37 ++++++++----------- .../2023-04-01-preview/types/common.json | 24 +----------- .../types/capabilityTypes.json | 37 ++++++++----------- .../2023-04-15-preview/types/common.json | 24 +----------- 4 files changed, 34 insertions(+), 88 deletions(-) diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-01-preview/types/capabilityTypes.json b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-01-preview/types/capabilityTypes.json index 5fa9e0d41ccb..87e773bc06c0 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-01-preview/types/capabilityTypes.json +++ b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-01-preview/types/capabilityTypes.json @@ -71,28 +71,21 @@ "description": "String of the kind of this Capability Type.", "readOnly": true }, - "permissionsNecessary": { - "type": "object", - "description": "Array of control and data plane actions necessary to execute capability type.", - "properties": { - "actions": { - "type": "array", - "description": "Control plane actions necessary to execute capability type.", - "items": { - "type": "string", - "description": "Control plane action necessary to execute capability type." - } - }, - "dataActions": { - "type": "array", - "description": "Control plane actions necessary to execute capability type.", - "items": { - "type": "string", - "description": "Data plane action necessary to execute capability type." - } - } - }, - "readOnly": true + "azureRBACActions": { + "type": "array", + "description": "Control plane actions necessary to execute capability type.", + "items": { + "type": "string", + "description": "Control plane action necessary to execute capability type." + } + }, + "azureRBACDataActions": { + "type": "array", + "description": "Data plane actions necessary to execute capability type.", + "items": { + "type": "string", + "description": "Data plane action necessary to execute capability type." + } }, "runtimeProperties": { "type": "object", diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-01-preview/types/common.json b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-01-preview/types/common.json index e7710171ac39..a4d39bea74c5 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-01-preview/types/common.json +++ b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-01-preview/types/common.json @@ -24,8 +24,8 @@ } }, "userAssignedIdentities": { - "$ref": "#/definitions/userAssignedIdentities", - "description": "The list of user identities associated with the experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + "$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/UserAssignedIdentities", + "description": "The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." }, "principalId": { "type": "string", @@ -45,26 +45,6 @@ ], "additionalProperties": false }, - "userAssignedIdentities": { - "type": "object", - "description": "The list of user identities associated with the experiment.", - "additionalProperties": { - "type": "object", - "description": "The list of user identities associated with the experiment.", - "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." - } - } - } - }, "url": { "type": "string", "description": "String that represents a URL.", diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-15-preview/types/capabilityTypes.json b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-15-preview/types/capabilityTypes.json index e039cf528df9..1aeed6328dbf 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-15-preview/types/capabilityTypes.json +++ b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-15-preview/types/capabilityTypes.json @@ -71,28 +71,21 @@ "description": "String of the kind of this Capability Type.", "readOnly": true }, - "permissionsNecessary": { - "type": "object", - "description": "Array of control and data plane actions necessary to execute capability type.", - "properties": { - "actions": { - "type": "array", - "description": "Control plane actions necessary to execute capability type.", - "items": { - "type": "string", - "description": "Control plane action necessary to execute capability type." - } - }, - "dataActions": { - "type": "array", - "description": "Control plane actions necessary to execute capability type.", - "items": { - "type": "string", - "description": "Data plane action necessary to execute capability type." - } - } - }, - "readOnly": true + "azureRBACActions": { + "type": "array", + "description": "Control plane actions necessary to execute capability type.", + "items": { + "type": "string", + "description": "Control plane action necessary to execute capability type." + } + }, + "azureRBACDataActions": { + "type": "array", + "description": "Data plane actions necessary to execute capability type.", + "items": { + "type": "string", + "description": "Data plane action necessary to execute capability type." + } }, "runtimeProperties": { "type": "object", diff --git a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-15-preview/types/common.json b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-15-preview/types/common.json index 0bffedc22c3c..86785a4c7ff2 100644 --- a/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-15-preview/types/common.json +++ b/specification/chaos/resource-manager/Microsoft.Chaos/preview/2023-04-15-preview/types/common.json @@ -24,8 +24,8 @@ } }, "userAssignedIdentities": { - "$ref": "#/definitions/userAssignedIdentities", - "description": "The list of user identities associated with the experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + "$ref": "../../../../../../common-types/resource-management/v3/managedidentity.json#/definitions/UserAssignedIdentities", + "description": "The list of user identities associated with the Experiment. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." }, "principalId": { "type": "string", @@ -45,26 +45,6 @@ ], "additionalProperties": false }, - "userAssignedIdentities": { - "type": "object", - "description": "The list of user identities associated with the experiment.", - "additionalProperties": { - "type": "object", - "description": "The list of user identities associated with the experiment.", - "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." - } - } - } - }, "url": { "type": "string", "description": "String that represents a URL.", From 8904226c7ddf652b4c37dda4e97725c8aeee8442 Mon Sep 17 00:00:00 2001 From: anmolbohra97 <90467366+anmolbohra97@users.noreply.github.com> Date: Thu, 4 May 2023 10:12:40 -0700 Subject: [PATCH 20/79] Adding new statuses and a property to EmailDeliveryReportReceived Event (#23593) * Adding new status to EmailDeliveryReportReceived Event Adding new status value "Suppressed" to EmailDeliveryReportReceived Event in AcsEvents * Adding new property to Email event * Adding new status * Updates from feedback. * Adding description for the enum * Fix Prettier check * Update description * Updating example * Updated swagger object def * Updating property name * renaming property --- .../AzureCommunicationServices.json | 50 +++++++++++++++++-- .../email_delivery_report_received.json | 5 +- 2 files changed, 50 insertions(+), 5 deletions(-) diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index 2321763cdf4a..a4d87093ee38 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -519,19 +519,51 @@ "type": "string" }, "status": { - "description": "The status of the email", + "description": "The status of the email. Any value other than Delivered is considered failed.", "type": "string", "enum": [ - "Failed", + "Bounced", "Delivered", + "Failed", "FilteredSpam", - "Quarantined" + "Quarantined", + "Suppressed" ], "x-ms-enum": { "name": "AcsEmailDeliveryReportStatus", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Bounced", + "description": "Hard bounce detected while sending the email" + }, + { + "value": "Delivered", + "description": "The email was delivered" + }, + { + "value": "Failed", + "description": "The email failed to be delivered" + }, + { + "value": "FilteredSpam", + "description": "The message was identified spam and was rejected or blocked (not quarantined)." + }, + { + "value": "Quarantined", + "description": "The message was quarantined (as spam, bulk mail, or phishing). For more information, see Quarantined email messages in EOP (EXCHANGE ONLINE PROTECTION)." + }, + { + "value": "Suppressed", + "description": "The email was suppressed" + } + ] } }, + "deliveryStatusDetails": { + "description": "Detailed information about the status if any", + "$ref": "#/definitions/AcsEmailDeliveryReportStatusDetails" + }, "deliveryAttemptTimeStamp": { "description": "The time at which the email delivery report received timestamp", "format": "date-time", @@ -819,6 +851,16 @@ "type": "string" } } + }, + "AcsEmailDeliveryReportStatusDetails": { + "description": "Detailed information about the status if any", + "type": "object", + "properties": { + "statusMessage": { + "description": "Detailed status message", + "type": "string" + } + } } } } diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json index 2d6d6dcd7dfc..cd033a72e70a 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/email_delivery_report_received.json @@ -7,7 +7,10 @@ "recipient": "test1@contoso.com", "messageId": "950850f5-bcdf-4315-b77a-6447cf56fac9", "status": "delivered", - "deliveryAttemptTimeStamp": "2023-02-09T19:46:12.2480265+00:00" + "deliveryAttemptTimeStamp": "2023-02-09T19:46:12.2480265+00:00", + "deliveryStatusDetails": { + "statusMessage": "DestinationMailboxFull" + } }, "eventType": "Microsoft.Communication.EmailDeliveryReportReceived", "dataVersion": "1.0", From b53cd31f04037e6f1b82dfc68d086e2d108eda13 Mon Sep 17 00:00:00 2001 From: Minh-Anh Phan <111523473+minhanh-phan@users.noreply.github.com> Date: Thu, 4 May 2023 10:57:32 -0700 Subject: [PATCH 21/79] [Language] Remove duplication for PreBuiltResult and InputError (#23788) * Remove duplication for PreBuiltResult and InputError * Remove RequestStatistics in analyzetext.json * Remove additionalProperties * Add object type for PreBuiltResult --- .../data-plane/Language/analyzetext.json | 93 ++----------------- .../data-plane/Language/common.json | 8 +- .../stable/2023-04-01/analyzetext.json | 93 ++----------------- .../Language/stable/2023-04-01/common.json | 8 +- 4 files changed, 28 insertions(+), 174 deletions(-) diff --git a/dev/cognitiveservices/data-plane/Language/analyzetext.json b/dev/cognitiveservices/data-plane/Language/analyzetext.json index 55414aef6cee..430b85f28f0b 100644 --- a/dev/cognitiveservices/data-plane/Language/analyzetext.json +++ b/dev/cognitiveservices/data-plane/Language/analyzetext.json @@ -545,29 +545,6 @@ } ] }, - "PreBuiltResult": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "modelVersion": { - "type": "string", - "description": "This field indicates which model is used for scoring." - } - }, - "required": [ - "errors", - "modelVersion" - ] - }, "CustomTaskParameters": { "type": "object", "description": "Parameters object for a text analysis task using custom models.", @@ -598,11 +575,11 @@ "type": "array", "description": "Errors by document id.", "items": { - "$ref": "#/definitions/DocumentError" + "$ref": "common.json#/definitions/DocumentError" } }, "statistics": { - "$ref": "#/definitions/RequestStatistics" + "$ref": "common.json#/definitions/RequestStatistics" }, "projectName": { "type": "string", @@ -825,7 +802,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -1168,7 +1145,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -1505,7 +1482,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -1634,7 +1611,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -1803,7 +1780,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -2247,7 +2224,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -2313,7 +2290,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -2395,7 +2372,7 @@ "AnalyzeTextJobStatistics": { "properties": { "statistics": { - "$ref": "#/definitions/RequestStatistics" + "$ref": "common.json#/definitions/RequestStatistics" } }, "type": "object" @@ -2692,24 +2669,6 @@ } } }, - "DocumentError": { - "type": "object", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "Document Id." - }, - "error": { - "type": "object", - "description": "Document Error.", - "$ref": "common.json#/definitions/Error" - } - } - }, "DocumentWarning": { "type": "object", "required": [ @@ -2759,38 +2718,6 @@ }, "description": "if showStats=true was specified in the request this field will contain information about the document payload." }, - "RequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount", - "transactionsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - }, - "transactionsCount": { - "type": "integer", - "format": "int64", - "description": "Number of transactions for the request." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the request payload." - }, "MultiLanguageInput": { "type": "object", "description": "Contains an input document to be analyzed by the service.", diff --git a/dev/cognitiveservices/data-plane/Language/common.json b/dev/cognitiveservices/data-plane/Language/common.json index b6cab8b6107f..7f583cdb4d14 100644 --- a/dev/cognitiveservices/data-plane/Language/common.json +++ b/dev/cognitiveservices/data-plane/Language/common.json @@ -301,7 +301,7 @@ }, "type": "object" }, - "InputError": { + "DocumentError": { "type": "object", "description": "Contains details of errors encountered during a job execution.", "required": [ @@ -311,7 +311,7 @@ "properties": { "id": { "type": "string", - "description": "The ID of the input." + "description": "The ID of the input document." }, "error": { "type": "object", @@ -372,16 +372,16 @@ "description": "Number of transactions for the request." } }, - "additionalProperties": true, "description": "if showStats=true was specified in the request this field will contain information about the request payload." }, "PreBuiltResult": { + "type": "object", "properties": { "errors": { "type": "array", "description": "Errors by document id.", "items": { - "$ref": "#/definitions/InputError" + "$ref": "#/definitions/DocumentError" } }, "statistics": { diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzetext.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzetext.json index 55414aef6cee..430b85f28f0b 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzetext.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzetext.json @@ -545,29 +545,6 @@ } ] }, - "PreBuiltResult": { - "type": "object", - "properties": { - "errors": { - "type": "array", - "description": "Errors by document id.", - "items": { - "$ref": "#/definitions/DocumentError" - } - }, - "statistics": { - "$ref": "#/definitions/RequestStatistics" - }, - "modelVersion": { - "type": "string", - "description": "This field indicates which model is used for scoring." - } - }, - "required": [ - "errors", - "modelVersion" - ] - }, "CustomTaskParameters": { "type": "object", "description": "Parameters object for a text analysis task using custom models.", @@ -598,11 +575,11 @@ "type": "array", "description": "Errors by document id.", "items": { - "$ref": "#/definitions/DocumentError" + "$ref": "common.json#/definitions/DocumentError" } }, "statistics": { - "$ref": "#/definitions/RequestStatistics" + "$ref": "common.json#/definitions/RequestStatistics" }, "projectName": { "type": "string", @@ -825,7 +802,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -1168,7 +1145,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -1505,7 +1482,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -1634,7 +1611,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -1803,7 +1780,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -2247,7 +2224,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -2313,7 +2290,7 @@ }, "allOf": [ { - "$ref": "#/definitions/PreBuiltResult" + "$ref": "common.json#/definitions/PreBuiltResult" } ], "required": [ @@ -2395,7 +2372,7 @@ "AnalyzeTextJobStatistics": { "properties": { "statistics": { - "$ref": "#/definitions/RequestStatistics" + "$ref": "common.json#/definitions/RequestStatistics" } }, "type": "object" @@ -2692,24 +2669,6 @@ } } }, - "DocumentError": { - "type": "object", - "required": [ - "id", - "error" - ], - "properties": { - "id": { - "type": "string", - "description": "Document Id." - }, - "error": { - "type": "object", - "description": "Document Error.", - "$ref": "common.json#/definitions/Error" - } - } - }, "DocumentWarning": { "type": "object", "required": [ @@ -2759,38 +2718,6 @@ }, "description": "if showStats=true was specified in the request this field will contain information about the document payload." }, - "RequestStatistics": { - "type": "object", - "required": [ - "documentsCount", - "validDocumentsCount", - "erroneousDocumentsCount", - "transactionsCount" - ], - "properties": { - "documentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of documents submitted in the request." - }, - "validDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." - }, - "erroneousDocumentsCount": { - "type": "integer", - "format": "int32", - "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." - }, - "transactionsCount": { - "type": "integer", - "format": "int64", - "description": "Number of transactions for the request." - } - }, - "description": "if showStats=true was specified in the request this field will contain information about the request payload." - }, "MultiLanguageInput": { "type": "object", "description": "Contains an input document to be analyzed by the service.", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/common.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/common.json index b6cab8b6107f..7f583cdb4d14 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/common.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/common.json @@ -301,7 +301,7 @@ }, "type": "object" }, - "InputError": { + "DocumentError": { "type": "object", "description": "Contains details of errors encountered during a job execution.", "required": [ @@ -311,7 +311,7 @@ "properties": { "id": { "type": "string", - "description": "The ID of the input." + "description": "The ID of the input document." }, "error": { "type": "object", @@ -372,16 +372,16 @@ "description": "Number of transactions for the request." } }, - "additionalProperties": true, "description": "if showStats=true was specified in the request this field will contain information about the request payload." }, "PreBuiltResult": { + "type": "object", "properties": { "errors": { "type": "array", "description": "Errors by document id.", "items": { - "$ref": "#/definitions/InputError" + "$ref": "#/definitions/DocumentError" } }, "statistics": { From c42edcece6b040c1a150b702d140348c2e1b3356 Mon Sep 17 00:00:00 2001 From: Srikanta <51379715+srnagar@users.noreply.github.com> Date: Thu, 4 May 2023 13:16:18 -0700 Subject: [PATCH 22/79] Update OpenAI tspconfig to include Java emitter config (#23774) * Update OpenAI tspconfig to include Java emitter config * remove unions for embedding options * update docs --- .../OpenAI.Inference/models/embeddings.create.tsp | 5 ++--- .../cognitiveservices/OpenAI.Inference/tspconfig.yaml | 5 ++++- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.tsp index cd6f6f27a415..2ed1da7468b2 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/embeddings.create.tsp @@ -27,14 +27,13 @@ model EmbeddingsOptions { "model"?: string; @doc(""" - Input text to get embeddings for, encoded as a string. - To get embeddings for multiple inputs in a single request, pass an array of strings. + Input texts to get embeddings for, encoded as a an array of strings. Each input must not exceed 2048 tokens in length. Unless you are embedding code, we suggest replacing newlines (\\n) in your input with a single space, as we have observed inferior results when newlines are present. """) - input: string | string[]; + input: string[]; }; @doc(""" diff --git a/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml b/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml index f23f19ca19e0..9300c257a2d1 100644 --- a/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml +++ b/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml @@ -14,4 +14,7 @@ options: "@azure-tools/typespec-csharp": namespace: "Azure.AI.OpenAI" clear-output-folder: true - model-namespace: false \ No newline at end of file + model-namespace: false + "@azure-tools/typespec-java": + namespace: "com.azure.ai.openai" + partial-update: true \ No newline at end of file From e7e775e2f3fe00f25fbd0e7ca0d953e22eef93ff Mon Sep 17 00:00:00 2001 From: Carey Halton Date: Thu, 4 May 2023 18:32:45 -0400 Subject: [PATCH 23/79] New Azure Cognitive Search API version 2023-07-01-Preview (#23779) * New Azure Cognitive Search API version 2023-07-01-Preview * Add Edm.Single as allowed search field type * Remove unused query debug modes * Add new api version to README * Use additionalProperties: true * Define schema for document lookup result --- custom-words.txt | 5 +- .../SearchIndexAutocompleteDocumentsGet.json | 38 + .../SearchIndexAutocompleteDocumentsPost.json | 36 + .../examples/SearchIndexCountDocuments.json | 12 + .../examples/SearchIndexGetDocument.json | 22 + .../examples/SearchIndexIndexDocuments.json | 93 + .../SearchIndexSearchDocumentsGet.json | 86 + .../SearchIndexSearchDocumentsPost.json | 101 + .../SearchIndexSuggestDocumentsGet.json | 47 + .../SearchIndexSuggestDocumentsPost.json | 39 + .../examples/SearchServiceCreateAlias.json | 22 + .../SearchServiceCreateDataSource.json | 70 + .../examples/SearchServiceCreateIndex.json | 429 + .../examples/SearchServiceCreateIndexer.json | 58 + .../SearchServiceCreateOrUpdateAlias.json | 32 + ...SearchServiceCreateOrUpdateDataSource.json | 95 + .../SearchServiceCreateOrUpdateIndex.json | 654 + .../SearchServiceCreateOrUpdateIndexer.json | 78 + .../SearchServiceCreateOrUpdateSkillset.json | 387 + ...SearchServiceCreateOrUpdateSynonymMap.json | 47 + .../examples/SearchServiceCreateSkillset.json | 307 + .../SearchServiceCreateSynonymMap.json | 38 + .../examples/SearchServiceDeleteAlias.json | 11 + .../SearchServiceDeleteDataSource.json | 11 + .../examples/SearchServiceDeleteIndex.json | 11 + .../examples/SearchServiceDeleteIndexer.json | 11 + .../examples/SearchServiceDeleteSkillset.json | 11 + .../SearchServiceDeleteSynonymMap.json | 11 + .../examples/SearchServiceGetAlias.json | 17 + .../examples/SearchServiceGetDataSource.json | 41 + .../examples/SearchServiceGetIndex.json | 244 + .../SearchServiceGetIndexStatistics.json | 15 + .../examples/SearchServiceGetIndexer.json | 36 + .../SearchServiceGetIndexerStatus.json | 89 + .../SearchServiceGetServiceStatistics.json | 52 + .../examples/SearchServiceGetSkillset.json | 144 + .../examples/SearchServiceGetSynonymMap.json | 25 + .../examples/SearchServiceIndexAnalyze.json | 37 + .../examples/SearchServiceListAliases.json | 26 + .../SearchServiceListDataSources.json | 45 + .../examples/SearchServiceListIndexers.json | 76 + .../examples/SearchServiceListIndexes.json | 287 + .../examples/SearchServiceListSkillsets.json | 148 + .../SearchServiceListSynonymMaps.json | 31 + .../examples/SearchServiceResetDocs.json | 17 + .../examples/SearchServiceResetIndexer.json | 10 + .../examples/SearchServiceResetSkills.json | 16 + .../examples/SearchServiceRunIndexer.json | 10 + .../2023-07-01-Preview/searchindex.json | 2730 ++++ .../2023-07-01-Preview/searchservice.json | 11596 ++++++++++++++++ .../search/data-plane/Azure.Search/readme.md | 43 +- 51 files changed, 18495 insertions(+), 2 deletions(-) create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexAutocompleteDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexAutocompleteDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexCountDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexGetDocument.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexIndexDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSearchDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSearchDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSuggestDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSuggestDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetAlias.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexerStatus.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetServiceStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceIndexAnalyze.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListAliases.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListDataSources.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListIndexers.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListIndexes.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListSkillsets.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListSynonymMaps.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetDocs.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetSkills.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceRunIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchindex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json diff --git a/custom-words.txt b/custom-words.txt index 17bd8b3fe319..aac05ed1eecc 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2801,4 +2801,7 @@ GTID gtid Wifi Nwfs - +Hnsw +Piqd +Reranked +Reranking diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexAutocompleteDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexAutocompleteDocumentsGet.json new file mode 100644 index 000000000000..21f4d6a2abfc --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexAutocompleteDocumentsGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2023-07-01-Preview", + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": [ + "title", + "description" + ], + "top": 10 + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexAutocompleteDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexAutocompleteDocumentsPost.json new file mode 100644 index 000000000000..e056a20d2a1d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexAutocompleteDocumentsPost.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2023-07-01-Preview", + "autocompleteRequest": { + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": "title,description", + "top": 10 + } + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexCountDocuments.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexCountDocuments.json new file mode 100644 index 000000000000..6e174524e986 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexCountDocuments.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": 427 + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexGetDocument.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexGetDocument.json new file mode 100644 index 000000000000..aa9d13e4b947 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexGetDocument.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2023-07-01-Preview", + "key": "1", + "$select": [ + "docId", + "title", + "description" + ] + }, + "responses": { + "200": { + "body": { + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexIndexDocuments.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexIndexDocuments.json new file mode 100644 index 000000000000..9ec271c6c34e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexIndexDocuments.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2023-07-01-Preview", + "batch": { + "value": [ + { + "@search.action": "upload", + "docId": "1", + "title": "Fancy Stay", + "description": "Best hotel in town" + }, + { + "@search.action": "merge", + "docId": "2", + "title": "Roach Motel" + }, + { + "@search.action": "mergeOrUpload", + "docId": "3", + "title": "Econo Motel" + }, + { + "@search.action": "delete", + "docId": "4" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 201 + }, + { + "key": "2", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + }, + "207": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "2", + "status": false, + "errorMessage": "Document not found.", + "statusCode": 404 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSearchDocumentsGet.json new file mode 100644 index 000000000000..8b8dad0dc4a2 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSearchDocumentsGet.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2023-07-01-Preview", + "$count": true, + "facet": [ + "category,count:10,sort:count" + ], + "$filter": "rating gt 10", + "highlight": [ + "title" + ], + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "queryType": "simple", + "sessionId": "mysessionid", + "scoringStatistics": "global", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": [ + "title", + "description" + ], + "searchMode": "any", + "$select": [ + "docId", + "title", + "description" + ], + "$skip": 100, + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.coverage": 80, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "Nice Hotel" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy Hotel" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSearchDocumentsPost.json new file mode 100644 index 000000000000..0090179834b8 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSearchDocumentsPost.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2023-07-01-Preview", + "searchRequest": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "search.score() desc,rating desc", + "queryType": "simple", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "title,description", + "searchMode": "any", + "sessionId": "mysessionid", + "scoringStatistics": "global", + "select": "docId,title,description", + "skip": 0, + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "@search.nextPageParameters": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "search.score() desc,rating desc", + "queryType": "simple", + "sessionId": "mysessionid", + "scoringStatistics": "global", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "title,description", + "searchMode": "any", + "select": "docId,title,description", + "skip": 2, + "top": 8 + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "Nice Hotel" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy Hotel" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ], + "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2023-07-01-Preview" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSuggestDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSuggestDocumentsGet.json new file mode 100644 index 000000000000..f8821bde5d5b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSuggestDocumentsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2023-07-01-Preview", + "$filter": "rating gt 10", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "search": "hote", + "searchFields": [ + "title" + ], + "suggesterName": "sg", + "$select": [ + "docId", + "title", + "description" + ], + "$top": 10 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSuggestDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSuggestDocumentsPost.json new file mode 100644 index 000000000000..ed123ca7112f --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchIndexSuggestDocumentsPost.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2023-07-01-Preview", + "suggestRequest": { + "filter": "rating gt 4.0", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "orderby": "rating desc", + "search": "hote", + "searchFields": "title", + "select": "docId,title,description", + "suggesterName": "sg", + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateAlias.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateAlias.json new file mode 100644 index 000000000000..6f0603d0ad6c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateAlias.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2023-07-01-Preview", + "alias": { + "name": "production", + "indexes": [ + "hotels" + ] + } + }, + "responses": { + "201": { + "body": { + "name": "production", + "indexes": [ + "hotels" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateDataSource.json new file mode 100644 index 000000000000..3028264200a4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateDataSource.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2023-07-01-Preview", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateIndex.json new file mode 100644 index 000000000000..a41d4eedd6fe --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateIndex.json @@ -0,0 +1,429 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2023-07-01-Preview", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "b": 0.5, + "k1": 1.3 + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "b": 0.5, + "k1": 1.3 + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateIndexer.json new file mode 100644 index 000000000000..30f23c7d1af6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateIndexer.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2023-07-01-Preview", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateAlias.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateAlias.json new file mode 100644 index 000000000000..2fc7ec0fa41b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateAlias.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "aliasName": "production", + "api-version": "2023-07-01-Preview", + "Prefer": "return=representation", + "alias": { + "name": "production", + "indexes": [ + "hotels" + ] + } + }, + "responses": { + "200": { + "body": { + "name": "production", + "indexes": [ + "hotels" + ] + } + }, + "201": { + "body": { + "name": "production", + "indexes": [ + "hotels" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateDataSource.json new file mode 100644 index 000000000000..750b915f9f3e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateDataSource.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2023-07-01-Preview", + "Prefer": "return=representation", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateIndex.json new file mode 100644 index 000000000000..245e1d8e5c6d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateIndex.json @@ -0,0 +1,654 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "allowIndexDowntime": false, + "api-version": "2023-07-01-Preview", + "Prefer": "return=representation", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity" + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity" + } + } + }, + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "semantic": { + "configurations": [ + { + "name": "semanticHotels", + "prioritizedFields": { + "titleField": { + "fieldName": "hotelName" + }, + "prioritizedContentFields": [ + { + "fieldName": "description" + }, + { + "fieldName": "description_fr" + } + ], + "prioritizedKeywordsFields": [ + { + "fieldName": "tags" + }, + { + "fieldName": "category" + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateIndexer.json new file mode 100644 index 000000000000..d56d40270dd3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateIndexer.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2023-07-01-Preview", + "Prefer": "return=representation", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateSkillset.json new file mode 100644 index 000000000000..268a331670ab --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateSkillset.json @@ -0,0 +1,387 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2023-07-01-Preview", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json new file mode 100644 index 000000000000..91382edd0c38 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2023-07-01-Preview", + "Prefer": "return=representation", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateSkillset.json new file mode 100644 index 000000000000..9feab5958ac8 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateSkillset.json @@ -0,0 +1,307 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2023-07-01-Preview", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "knowledgeStore": { + "storageConnectionString": "DefaultEndpointsProtocol=https;AccountName=myStorage;AccountKey=myStorageKey;EndpointSuffix=core.windows.net", + "projections": [ + { + "tables": [ + { + "tableName": "Reviews", + "generatedKeyName": "ReviewId", + "source": "/document/Review", + "sourceContext": null, + "inputs": [] + }, + { + "tableName": "Sentences", + "generatedKeyName": "SentenceId", + "source": "/document/Review/Sentences/*", + "sourceContext": null, + "inputs": [] + }, + { + "tableName": "KeyPhrases", + "generatedKeyName": "KeyPhraseId", + "source": "/document/Review/Sentences/*/KeyPhrases", + "sourceContext": null, + "inputs": [] + }, + { + "tableName": "Entities", + "generatedKeyName": "EntityId", + "source": "/document/Review/Sentences/*/Entities/*", + "sourceContext": null, + "inputs": [] + } + ] + }, + { + "objects": [ + { + "storageContainer": "Reviews", + "source": "/document/Review", + "generatedKeyName": "/document/Review/Id" + } + ] + } + ] + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateSynonymMap.json new file mode 100644 index 000000000000..859e71915814 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceCreateSynonymMap.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2023-07-01-Preview", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "myApplicationSecret" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteAlias.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteAlias.json new file mode 100644 index 000000000000..3d46be10db95 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteAlias.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "aliasName": "staging", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteDataSource.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteDataSource.json new file mode 100644 index 000000000000..83205cfd12ec --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteDataSource.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteIndex.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteIndex.json new file mode 100644 index 000000000000..f161ebe4e5a6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteIndex.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteIndexer.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteIndexer.json new file mode 100644 index 000000000000..b279b9d2a8f3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteIndexer.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteSkillset.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteSkillset.json new file mode 100644 index 000000000000..dd32a5cb9068 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteSkillset.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteSynonymMap.json new file mode 100644 index 000000000000..fb920bf27cde --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceDeleteSynonymMap.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetAlias.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetAlias.json new file mode 100644 index 000000000000..2a514d363353 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetAlias.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "aliasName": "production", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "name": "production", + "indexes": [ + "hotels" + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetDataSource.json new file mode 100644 index 000000000000..2c866c45e3f1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetDataSource.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndex.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndex.json new file mode 100644 index 000000000000..c197f5723aa6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndex.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexStatistics.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexStatistics.json new file mode 100644 index 000000000000..e98dfa1688e8 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexStatistics.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "documentCount": 239572, + "storageSize": 72375920 + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexer.json new file mode 100644 index 000000000000..3bfdfb0c13b7 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexer.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexerStatus.json new file mode 100644 index 000000000000..072e03a1f70d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetIndexerStatus.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "status": "running", + "lastResult": { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + "executionHistory": [ + { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + { + "status": "transientFailure", + "errorMessage": null, + "startTime": "2014-11-26T03:28:10.125Z", + "endTime": "2014-11-26T03:28:12.007Z", + "errors": [ + { + "key": "", + "errorMessage": "Document key cannot be missing or empty.", + "statusCode": 400, + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 1", + "errorMessage": "Could not read the value of column 'foo' at index '0'.", + "statusCode": 400, + "name": "DocumentExtraction.AzureBlob.MyDataSource", + "details": "The file could not be parsed.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388" + } + ], + "warnings": [ + { + "key": "document id", + "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob.", + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 2", + "message": "Document was truncated to 50000 characters.", + "name": "Enrichment.LanguageDetectionSkill.#4", + "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692" + } + ], + "itemsProcessed": 1, + "itemsFailed": 2, + "initialTrackingState": null, + "finalTrackingState": null + } + ], + "limits": { + "maxRunTime": "PT22H", + "maxDocumentExtractionSize": 256000000, + "maxDocumentContentCharactersToExtract": 4000000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetServiceStatistics.json new file mode 100644 index 000000000000..5f5f3ff256fd --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetServiceStatistics.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "counters": { + "aliasesCount": { + "usage": 2, + "quota": 3 + }, + "documentCount": { + "usage": 7093, + "quota": 10000 + }, + "indexesCount": { + "usage": 3, + "quota": 3 + }, + "indexersCount": { + "usage": 3, + "quota": 3 + }, + "dataSourcesCount": { + "usage": 1, + "quota": 3 + }, + "storageSize": { + "usage": 914529, + "quota": 52428800 + }, + "synonymMaps": { + "usage": 2, + "quota": 3 + }, + "skillsetCount": { + "usage": 0, + "quota": 3 + } + }, + "limits": { + "maxFieldsPerIndex": 1000, + "maxFieldNestingDepthPerIndex": 10, + "maxComplexCollectionFieldsPerIndex": 100, + "maxComplexObjectsInCollectionsPerDocument": 3000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetSkillset.json new file mode 100644 index 000000000000..a5e24c16bcee --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetSkillset.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetSynonymMap.json new file mode 100644 index 000000000000..6384cc1ae30b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceGetSynonymMap.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceIndexAnalyze.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceIndexAnalyze.json new file mode 100644 index 000000000000..051c95814b9c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceIndexAnalyze.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2023-07-01-Preview", + "request": { + "text": "Text to analyze", + "analyzer": "standard.lucene" + } + }, + "responses": { + "200": { + "body": { + "tokens": [ + { + "token": "text", + "startOffset": 0, + "endOffset": 4, + "position": 0 + }, + { + "token": "to", + "startOffset": 5, + "endOffset": 7, + "position": 1 + }, + { + "token": "analyze", + "startOffset": 8, + "endOffset": 15, + "position": 2 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListAliases.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListAliases.json new file mode 100644 index 000000000000..54e188d7ea4a --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListAliases.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "production", + "indexes": [ + "hotels" + ] + }, + { + "name": "staging", + "indexes": [ + "testindex" + ] + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListDataSources.json new file mode 100644 index 000000000000..89dbd6b1e564 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListDataSources.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListIndexers.json new file mode 100644 index 000000000000..80df5525d961 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListIndexers.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydocdbdatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + }, + { + "name": "myotherindexer", + "description": "another cool indexer", + "dataSourceName": "myblobdatasource", + "targetIndexName": "orders", + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "batchSize": 15 + }, + "fieldMappings": [ + { + "sourceFieldName": "PersonName", + "targetFieldName": "FirstName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 0 + } + } + }, + { + "sourceFieldName": "PersonName", + "targetFieldName": "LastName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 1 + } + } + } + ], + "disabled": false, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListIndexes.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListIndexes.json new file mode 100644 index 000000000000..2dde54b2d26c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListIndexes.json @@ -0,0 +1,287 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + }, + { + "name": "testindex", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": false, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "hidden", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": false, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [], + "defaultScoringProfile": null, + "suggesters": [], + "analyzers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": null, + "encryptionKey": null + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListSkillsets.json new file mode 100644 index 000000000000..d65915ebff14 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListSkillsets.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ], + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListSynonymMaps.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListSynonymMaps.json new file mode 100644 index 000000000000..f2f68df017b4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceListSynonymMaps.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + }, + { + "name": "myothersynonymmap", + "format": "solr", + "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat", + "encryptionKey": null + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetDocs.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetDocs.json new file mode 100644 index 000000000000..d43ed350b0db --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetDocs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2023-07-01-Preview", + "keysOrIds": { + "documentKeys": [ + "documentKey1", + "documentKey2" + ] + }, + "overwrite": false + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetIndexer.json new file mode 100644 index 000000000000..95b183cf4336 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetSkills.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetSkills.json new file mode 100644 index 000000000000..360fe3b008c3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceResetSkills.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "mySkillset", + "api-version": "2023-07-01-Preview", + "skillNames": { + "skillNames": [ + "skillName1", + "skillName2" + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceRunIndexer.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceRunIndexer.json new file mode 100644 index 000000000000..ad2b7acf8dd5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/examples/SearchServiceRunIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2023-07-01-Preview" + }, + "responses": { + "202": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchindex.json new file mode 100644 index 000000000000..d40123ee9c06 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchindex.json @@ -0,0 +1,2730 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchIndexClient", + "description": "Client that can be used to query an index and upload, merge, or delete documents.", + "version": "2023-07-01-Preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true, + "syncMethods": "None" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/indexes('{indexName}')", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + }, + { + "$ref": "#/parameters/IndexNameParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/docs/$count": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Count", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Count-Documents" + }, + "x-ms-examples": { + "SearchIndexCountDocuments": { + "$ref": "./examples/SearchIndexCountDocuments.json" + } + }, + "description": "Queries the number of documents in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "type": "integer", + "format": "int64" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsGet": { + "$ref": "./examples/SearchIndexSearchDocumentsGet.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "search", + "in": "query", + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + { + "name": "$count", + "in": "query", + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-nullable": false, + "x-ms-client-name": "IncludeTotalResultCount", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "facet", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.", + "x-ms-client-name": "Facets", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "The OData $filter expression to apply to the search query.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlight", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-client-name": "OrderBy", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryType", + "in": "query", + "type": "string", + "enum": [ + "simple", + "full", + "semantic" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringParameter", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-client-name": "ScoringParameters", + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes).", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringProfile", + "in": "query", + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticConfiguration", + "in": "query", + "type": "string", + "description": "The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticErrorHandling", + "in": "query", + "type": "string", + "enum": [ + "partial", + "fail" + ], + "x-ms-enum": { + "name": "SemanticErrorHandling", + "modelAsString": true, + "values": [ + { + "value": "partial", + "name": "Partial", + "description": "If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure." + }, + { + "value": "fail", + "name": "Fail", + "description": "If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error." + } + ] + }, + "description": "Allows the user to choose whether a semantic call should fail completely, or to return partial results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticMaxWaitInMilliseconds", + "in": "query", + "type": "integer", + "format": "int32", + "minimum": 700, + "description": "Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "debug", + "in": "query", + "type": "string", + "enum": [ + "disabled", + "semantic" + ], + "x-ms-enum": { + "name": "QueryDebugMode", + "modelAsString": true, + "values": [ + { + "value": "disabled", + "name": "Disabled", + "description": "No query debugging information will be returned." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Allows the user to further explore their Semantic search results." + } + ] + }, + "description": "Enables a debugging tool that can be used to further explore your search results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryLanguage", + "in": "query", + "type": "string", + "enum": [ + "none", + "en-us" + ], + "x-ms-enum": { + "name": "QueryLanguage", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Query language not specified." + }, + { + "value": "en-us", + "name": "EnUs", + "description": "English (US)" + } + ] + }, + "description": "The language of the query.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "speller", + "in": "query", + "type": "string", + "enum": [ + "none", + "lexicon" + ], + "x-ms-enum": { + "name": "Speller", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Speller not enabled." + }, + { + "value": "lexicon", + "name": "Lexicon", + "description": "Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter." + } + ] + }, + "description": "Improve search recall by spell-correcting individual search query terms.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "answers", + "in": "query", + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "Answers", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return answers for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." + } + ] + }, + "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchMode", + "in": "query", + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringStatistics", + "in": "query", + "type": "string", + "enum": [ + "local", + "global" + ], + "x-ms-enum": { + "name": "ScoringStatistics", + "modelAsString": false, + "values": [ + { + "value": "local", + "name": "Local", + "description": "The scoring statistics will be calculated locally for lower latency." + }, + { + "value": "global", + "name": "Global", + "description": "The scoring statistics will be calculated globally for more consistent scoring." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "sessionId", + "in": "query", + "type": "string", + "description": "A value to be used to create a sticky session, which can help to get more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$skip", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "captions", + "in": "query", + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "Captions", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return captions for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts captions from the matching documents that contain passages relevant to the search query." + } + ] + }, + "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-' option, such as 'extractive|highlight-true'. Defaults to 'None'.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "semanticFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names used for semantic search.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.search": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchPost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsPost": { + "$ref": "./examples/SearchIndexSearchDocumentsPost.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "searchRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchRequest", + "description": "The Search request." + }, + "description": "The definition of the Search request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs('{key}')": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Get", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/lookup-document" + }, + "x-ms-examples": { + "SearchIndexGetDocument": { + "$ref": "./examples/SearchIndexGetDocument.json" + } + }, + "description": "Retrieves a document from the index.", + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "description": "The key of the document to retrieve.", + "type": "string" + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.", + "x-ms-client-name": "SelectedFields" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "responses": { + "200": { + "description": "Response containing the requested document.", + "schema": { + "$ref": "#/definitions/LookupDocument" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.suggest": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsGet": { + "$ref": "./examples/SearchIndexSuggestDocumentsGet.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "search", + "in": "query", + "required": true, + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-nullable": false, + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-client-name": "OrderBy", + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to search for the specified search text. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, only the key field will be included in the results.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.suggest": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestPost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsPost": { + "$ref": "./examples/SearchIndexSuggestDocumentsPost.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "suggestRequest", + "in": "body", + "required": true, + "description": "The Suggest request.", + "schema": { + "$ref": "#/definitions/SuggestRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.index": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Index", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents" + }, + "x-ms-examples": { + "SearchIndexIndexDocuments": { + "$ref": "./examples/SearchIndexIndexDocuments.json" + } + }, + "description": "Sends a batch of document write actions to the index.", + "parameters": [ + { + "name": "batch", + "in": "body", + "description": "The batch of index actions.", + "required": true, + "schema": { + "$ref": "#/definitions/IndexBatch" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "207": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.autocomplete": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompleteGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsGet": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsGet.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "search", + "in": "query", + "type": "string", + "required": true, + "description": "The incomplete term which should be auto-completed.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "type": "string", + "required": true, + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "autocompleteMode", + "in": "query", + "type": "string", + "x-nullable": false, + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.autocomplete": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompletePost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsPost": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsPost.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "autocompleteRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutocompleteRequest" + }, + "description": "The definition of the Autocomplete request." + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + } + }, + "definitions": { + "SuggestDocumentsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@search.coverage": { + "type": "number", + "readOnly": true, + "format": "double", + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request." + } + }, + "required": [ + "value" + ], + "description": "Response containing suggestion query results from an index." + }, + "SuggestResult": { + "properties": { + "@search.text": { + "type": "string", + "readOnly": true, + "description": "The text of the suggestion result.", + "x-ms-client-name": "Text" + } + }, + "required": [ + "@search.text" + ], + "additionalProperties": true, + "description": "A result containing a document found by a suggestion query, plus associated metadata." + }, + "FacetResult": { + "properties": { + "count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The approximate count of documents falling within the bucket described by this facet." + } + }, + "additionalProperties": true, + "description": "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval." + }, + "AnswerResult": { + "properties": { + "score": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "The score value represents how relevant the answer is to the query relative to other answers returned for the query." + }, + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the document the answer was extracted from." + }, + "text": { + "type": "string", + "readOnly": true, + "description": "The text passage extracted from the document contents as the answer." + }, + "highlights": { + "type": "string", + "readOnly": true, + "x-nullable": true, + "description": "Same text passage as in the Text property with highlighted text phrases most relevant to the query." + } + }, + "additionalProperties": true, + "description": "An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected." + }, + "CaptionResult": { + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "A representative text passage extracted from the document most relevant to the search query." + }, + "highlights": { + "type": "string", + "readOnly": true, + "x-nullable": true, + "description": "Same text passage as in the Text property with highlighted phrases most relevant to the query." + } + }, + "additionalProperties": true, + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.." + }, + "SemanticPartialResponseReason": { + "type": "string", + "enum": [ + "maxWaitExceeded", + "capacityOverloaded", + "transient" + ], + "x-ms-enum": { + "name": "SemanticPartialResponseReason", + "modelAsString": true, + "values": [ + { + "value": "maxWaitExceeded", + "name": "MaxWaitExceeded", + "description": "If 'semanticMaxWaitInMilliseconds' was set and the semantic processing duration exceeded that value. Only the base results were returned." + }, + { + "value": "capacityOverloaded", + "name": "CapacityOverloaded", + "description": "The request was throttled. Only the base results were returned." + }, + { + "value": "transient", + "name": "Transient", + "description": "At least one step of the semantic process failed." + } + ] + }, + "description": "Reason that a partial response was returned for a semantic search request." + }, + "SemanticPartialResponseType": { + "type": "string", + "enum": [ + "baseResults", + "rerankedResults" + ], + "x-ms-enum": { + "name": "SemanticPartialResponseType", + "modelAsString": true, + "values": [ + { + "value": "baseResults", + "name": "BaseResults", + "description": "Results without any semantic enrichment or reranking." + }, + { + "value": "rerankedResults", + "name": "RerankedResults", + "description": "Results have been reranked with the reranker model and will include semantic captions. They will not include any answers, answers highlights or caption highlights." + } + ] + }, + "description": "Type of partial response that was returned for a semantic search request." + }, + "DocumentDebugInfo": { + "type": "object", + "properties": { + "semantic": { + "$ref": "#/definitions/SemanticDebugInfo", + "readOnly": true, + "description": "Contains debugging information specific to semantic search queries." + } + }, + "description": "Contains debugging information that can be used to further explore your search results." + }, + "SemanticDebugInfo": { + "type": "object", + "properties": { + "titleField": { + "$ref": "#/definitions/QueryResultDocumentSemanticField", + "readOnly": true, + "description": "The title field that was sent to the semantic enrichment process, as well as how it was used" + }, + "contentFields": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryResultDocumentSemanticField" + }, + "readOnly": true, + "description": "The content fields that were sent to the semantic enrichment process, as well as how they were used" + }, + "keywordFields": { + "type": "array", + "items": { + "$ref": "#/definitions/QueryResultDocumentSemanticField" + }, + "readOnly": true, + "description": "The keyword fields that were sent to the semantic enrichment process, as well as how they were used" + }, + "rerankerInput": { + "$ref": "#/definitions/QueryResultDocumentRerankerInput", + "readOnly": true, + "description": "The raw concatenated strings that were sent to the semantic enrichment process." + } + } + }, + "QueryResultDocumentSemanticField": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the field that was sent to the semantic enrichment process" + }, + "state": { + "$ref": "#/definitions/QueryResultDocumentSemanticFieldState", + "readOnly": true, + "description": "The way the field was used for the semantic enrichment process (fully used, partially used, or unused)" + } + }, + "description": "Description of fields that were sent to the semantic enrichment process, as well as how they were used" + }, + "QueryResultDocumentSemanticFieldState": { + "type": "string", + "enum": [ + "used", + "unused", + "partial" + ], + "x-ms-enum": { + "name": "QueryResultDocumentSemanticFieldState", + "modelAsString": true, + "values": [ + { + "value": "used", + "name": "Used", + "description": "The field was fully used for semantic enrichment." + }, + { + "value": "unused", + "name": "Unused", + "description": "The field was not used for semantic enrichment." + }, + { + "value": "partial", + "name": "Partial", + "description": "The field was partially used for semantic enrichment." + } + ] + }, + "description": "The way the field was used for the semantic enrichment process." + }, + "QueryResultDocumentRerankerInput": { + "type": "object", + "properties": { + "title": { + "type": "string", + "readOnly": true, + "description": "The raw string for the title field that was used for semantic enrichment." + }, + "content": { + "type": "string", + "readOnly": true, + "description": "The raw concatenated strings for the content fields that were used for semantic enrichment." + }, + "keywords": { + "type": "string", + "readOnly": true, + "description": "The raw concatenated strings for the keyword fields that were used for semantic enrichment." + } + }, + "description": "The raw concatenated strings that were sent to the semantic enrichment process." + }, + "SearchDocumentsResult": { + "properties": { + "@odata.count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "x-ms-client-name": "Count", + "description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response." + }, + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request." + }, + "@search.facets": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/FacetResult" + } + }, + "readOnly": true, + "x-ms-client-name": "Facets", + "description": "The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions." + }, + "@search.answers": { + "type": "array", + "items": { + "$ref": "#/definitions/AnswerResult" + }, + "readOnly": true, + "x-ms-client-name": "Answers", + "x-nullable": true, + "description": "The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'." + }, + "@search.nextPageParameters": { + "$ref": "#/definitions/SearchRequest", + "readOnly": true, + "x-ms-client-name": "NextPageParameters", + "description": "Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response." + }, + "@search.semanticPartialResponseReason": { + "$ref": "#/definitions/SemanticPartialResponseReason", + "readOnly": true, + "x-ms-client-name": "SemanticPartialResponseReason", + "description": "Reason that a partial response was returned for a semantic search request." + }, + "@search.semanticPartialResponseType": { + "$ref": "#/definitions/SemanticPartialResponseType", + "readOnly": true, + "x-ms-client-name": "SemanticPartialResponseType", + "description": "Type of partial response that was returned for a semantic search request." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@odata.nextLink": { + "type": "string", + "readOnly": true, + "x-ms-client-name": "NextLink", + "description": "Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response." + } + }, + "required": [ + "value" + ], + "description": "Response containing search results from an index." + }, + "SearchResult": { + "properties": { + "@search.score": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Score", + "x-nullable": false, + "description": "The relevance score of the document compared to other documents returned by the query." + }, + "@search.rerankerScore": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "RerankerScore", + "x-nullable": true, + "description": "The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'." + }, + "@search.highlights": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": true, + "x-ms-client-name": "Highlights", + "description": "Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query." + }, + "@search.captions": { + "type": "array", + "items": { + "$ref": "#/definitions/CaptionResult" + }, + "readOnly": true, + "x-ms-client-name": "Captions", + "x-nullable": true, + "description": "Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'." + }, + "@search.documentDebugInfo": { + "type": "array", + "items": { + "$ref": "#/definitions/DocumentDebugInfo" + }, + "readOnly": true, + "x-ms-client-name": "DocumentDebugInfo", + "x-nullable": true, + "description": "Contains debugging information that can be used to further explore your search results." + } + }, + "required": [ + "@search.score" + ], + "additionalProperties": true, + "description": "Contains a document found by a search query, plus associated metadata." + }, + "LookupDocument": { + "type": "object", + "additionalProperties": true, + "description": "A document retrieved via a document lookup operation." + }, + "IndexBatch": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IndexAction" + }, + "description": "The actions in the batch.", + "x-ms-client-name": "Actions" + } + }, + "required": [ + "value" + ], + "description": "Contains a batch of document write actions to send to the index." + }, + "IndexAction": { + "properties": { + "@search.action": { + "type": "string", + "enum": [ + "upload", + "merge", + "mergeOrUpload", + "delete" + ], + "x-ms-enum": { + "name": "IndexActionType", + "modelAsString": false, + "values": [ + { + "value": "upload", + "name": "Upload", + "description": "Inserts the document into the index if it is new and updates it if it exists. All fields are replaced in the update case." + }, + { + "value": "merge", + "name": "Merge", + "description": "Merges the specified field values with an existing document. If the document does not exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This also applies to collections of primitive and complex types." + }, + { + "value": "mergeOrUpload", + "name": "MergeOrUpload", + "description": "Behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document." + }, + { + "value": "delete", + "name": "Delete", + "description": "Removes the specified document from the index. Any field you specify in a delete operation other than the key field will be ignored. If you want to remove an individual field from a document, use merge instead and set the field explicitly to null." + } + ] + }, + "x-ms-client-name": "ActionType", + "x-nullable": false, + "description": "The operation to perform on a document in an indexing batch." + } + }, + "additionalProperties": true, + "description": "Represents an index action that operates on a document." + }, + "IndexingResult": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of a document that was in the indexing request." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded." + }, + "status": { + "x-ms-client-name": "Succeeded", + "type": "boolean", + "x-nullable": false, + "readOnly": true, + "description": "A value indicating whether the indexing operation succeeded for the document identified by the key." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + } + }, + "required": [ + "key", + "status", + "statusCode" + ], + "description": "Status of an indexing operation for a single document." + }, + "IndexDocumentsResult": { + "properties": { + "value": { + "x-ms-client-name": "Results", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexingResult" + }, + "description": "The list of status information for each document in the indexing request." + } + }, + "required": [ + "value" + ], + "description": "Response containing the status of operations for all documents in the indexing request." + }, + "SemanticErrorHandling": { + "type": "string", + "enum": [ + "partial", + "fail" + ], + "x-ms-enum": { + "name": "SemanticErrorHandling", + "modelAsString": true, + "values": [ + { + "value": "partial", + "name": "Partial", + "description": "If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure." + }, + { + "value": "fail", + "name": "Fail", + "description": "If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error." + } + ] + }, + "description": "Allows the user to choose whether a semantic call should fail completely, or to return partial results." + }, + "QueryDebugMode": { + "type": "string", + "enum": [ + "disabled", + "semantic" + ], + "x-ms-enum": { + "name": "QueryDebugMode", + "modelAsString": true, + "values": [ + { + "value": "disabled", + "name": "Disabled", + "description": "No query debugging information will be returned." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Allows the user to further explore their Semantic search results." + } + ] + }, + "description": "Enables a debugging tool that can be used to further explore your search results." + }, + "SearchMode": { + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "description": "Specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "QueryType": { + "type": "string", + "enum": [ + "simple", + "full", + "semantic" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + }, + { + "value": "semantic", + "name": "Semantic", + "description": "Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus." + } + ] + }, + "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax and 'semantic' if query syntax is not needed." + }, + "Speller": { + "type": "string", + "enum": [ + "none", + "lexicon" + ], + "x-ms-enum": { + "name": "QuerySpellerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Speller not enabled." + }, + { + "value": "lexicon", + "name": "Lexicon", + "description": "Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter." + } + ] + }, + "description": "Improve search recall by spell-correcting individual search query terms." + }, + "Answers": { + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryAnswerType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return answers for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language." + } + ] + }, + "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7." + }, + "Captions": { + "type": "string", + "enum": [ + "none", + "extractive" + ], + "x-ms-enum": { + "name": "QueryCaptionType", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Do not return captions for the query." + }, + { + "value": "extractive", + "name": "Extractive", + "description": "Extracts captions from the matching documents that contain passages relevant to the search query." + } + ] + }, + "description": "This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-' option, such as 'extractive|highlight-true'. Defaults to 'None'." + }, + "Vector": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "type": "number", + "format": "float" + }, + "description": "The vector representation of a search query." + }, + "k": { + "type": "integer", + "format": "int32", + "description": "Number of nearest neighbors to return as top hits." + }, + "fields": { + "type": "string", + "description": "Vector Fields of type Collection(Edm.Single) to be included in the vector searched." + } + }, + "description": "The query parameters for vector and hybrid search queries." + }, + "QueryLanguage": { + "type": "string", + "enum": [ + "none", + "en-us", + "en-gb", + "en-in", + "en-ca", + "en-au", + "fr-fr", + "fr-ca", + "de-de", + "es-es", + "es-mx", + "zh-cn", + "zh-tw", + "pt-br", + "pt-pt", + "it-it", + "ja-jp", + "ko-kr", + "ru-ru", + "cs-cz", + "nl-be", + "nl-nl", + "hu-hu", + "pl-pl", + "sv-se", + "tr-tr", + "hi-in", + "ar-sa", + "ar-eg", + "ar-ma", + "ar-kw", + "ar-jo", + "da-dk", + "no-no", + "bg-bg", + "hr-hr", + "hr-ba", + "ms-my", + "ms-bn", + "sl-sl", + "ta-in", + "vi-vn", + "el-gr", + "ro-ro", + "is-is", + "id-id", + "th-th", + "lt-lt", + "uk-ua", + "lv-lv", + "et-ee", + "ca-es", + "fi-fi", + "sr-ba", + "sr-me", + "sr-rs", + "sk-sk", + "nb-no", + "hy-am", + "bn-in", + "eu-es", + "gl-es", + "gu-in", + "he-il", + "ga-ie", + "kn-in", + "ml-in", + "mr-in", + "fa-ae", + "pa-in", + "te-in", + "ur-pk" + ], + "x-ms-enum": { + "name": "QueryLanguage", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Query language not specified." + }, + { + "value": "en-us", + "name": "EnUs", + "description": "Query language value for English (United States)." + }, + { + "value": "en-gb", + "name": "EnGb", + "description": "Query language value for English (Great Britain)." + }, + { + "value": "en-in", + "name": "EnIn", + "description": "Query language value for English (India)." + }, + { + "value": "en-ca", + "name": "EnCa", + "description": "Query language value for English (Canada)." + }, + { + "value": "en-au", + "name": "EnAu", + "description": "Query language value for English (Australia)." + }, + { + "value": "fr-fr", + "name": "FrFr", + "description": "Query language value for French (France)." + }, + { + "value": "fr-ca", + "name": "FrCa", + "description": "Query language value for French (Canada)." + }, + { + "value": "de-de", + "name": "DeDe", + "description": "Query language value for German (Germany)." + }, + { + "value": "es-es", + "name": "EsEs", + "description": "Query language value for Spanish (Spain)." + }, + { + "value": "es-mx", + "name": "EsMx", + "description": "Query language value for Spanish (Mexico)." + }, + { + "value": "zh-cn", + "name": "ZhCn", + "description": "Query language value for Chinese (China)." + }, + { + "value": "zh-tw", + "name": "ZhTw", + "description": "Query language value for Chinese (Taiwan)." + }, + { + "value": "pt-br", + "name": "PtBr", + "description": "Query language value for Portuguese (Brazil)." + }, + { + "value": "pt-pt", + "name": "PtPt", + "description": "Query language value for Portuguese (Portugal)." + }, + { + "value": "it-it", + "name": "ItIt", + "description": "Query language value for Italian (Italy)." + }, + { + "value": "ja-jp", + "name": "JaJp", + "description": "Query language value for Japanese (Japan)." + }, + { + "value": "ko-kr", + "name": "KoKr", + "description": "Query language value for Korean (Korea)." + }, + { + "value": "ru-ru", + "name": "RuRu", + "description": "Query language value for Russian (Russia)." + }, + { + "value": "cs-cz", + "name": "CsCz", + "description": "Query language value for Czech (Czech Republic)." + }, + { + "value": "nl-be", + "name": "NlBe", + "description": "Query language value for Dutch (Belgium)." + }, + { + "value": "nl-nl", + "name": "NlNl", + "description": "Query language value for Dutch (Netherlands)." + }, + { + "value": "hu-hu", + "name": "HuHu", + "description": "Query language value for Hungarian (Hungary)." + }, + { + "value": "pl-pl", + "name": "PlPl", + "description": "Query language value for Polish (Poland)." + }, + { + "value": "sv-se", + "name": "SvSe", + "description": "Query language value for Swedish (Sweden)." + }, + { + "value": "tr-tr", + "name": "TrTr", + "description": "Query language value for Turkish (Turkey)." + }, + { + "value": "hi-in", + "name": "HiIn", + "description": "Query language value for Hindi (India)." + }, + { + "value": "ar-sa", + "name": "ArSa", + "description": "Query language value for Arabic (Saudi Arabia)." + }, + { + "value": "ar-eg", + "name": "ArEg", + "description": "Query language value for Arabic (Egypt)." + }, + { + "value": "ar-ma", + "name": "ArMa", + "description": "Query language value for Arabic (Morocco)." + }, + { + "value": "ar-kw", + "name": "ArKw", + "description": "Query language value for Arabic (Kuwait)." + }, + { + "value": "ar-jo", + "name": "ArJo", + "description": "Query language value for Arabic (Jordan)." + }, + { + "value": "da-dk", + "name": "DaDk", + "description": "Query language value for Danish (Denmark)." + }, + { + "value": "no-no", + "name": "NoNo", + "description": "Query language value for Norwegian (Norway)." + }, + { + "value": "bg-bg", + "name": "BgBg", + "description": "Query language value for Bulgarian (Bulgaria)." + }, + { + "value": "hr-hr", + "name": "HrHr", + "description": "Query language value for Croatian (Croatia)." + }, + { + "value": "hr-ba", + "name": "HrBa", + "description": "Query language value for Croatian (Bosnia and Herzegovina)." + }, + { + "value": "ms-my", + "name": "MsMy", + "description": "Query language value for Malay (Malaysia)." + }, + { + "value": "ms-bn", + "name": "MsBn", + "description": "Query language value for Malay (Brunei Darussalam)." + }, + { + "value": "sl-sl", + "name": "SlSl", + "description": "Query language value for Slovenian (Slovenia)." + }, + { + "value": "ta-in", + "name": "TaIn", + "description": "Query language value for Tamil (India)." + }, + { + "value": "vi-vn", + "name": "ViVn", + "description": "Query language value for Vietnamese (Viet Nam)." + }, + { + "value": "el-gr", + "name": "ElGr", + "description": "Query language value for Greek (Greece)." + }, + { + "value": "ro-ro", + "name": "RoRo", + "description": "Query language value for Romanian (Romania)." + }, + { + "value": "is-is", + "name": "IsIs", + "description": "Query language value for Icelandic (Iceland)." + }, + { + "value": "id-id", + "name": "IdId", + "description": "Query language value for Indonesian (Indonesia)." + }, + { + "value": "th-th", + "name": "ThTh", + "description": "Query language value for Thai (Thailand)." + }, + { + "value": "lt-lt", + "name": "LtLt", + "description": "Query language value for Lithuanian (Lithuania)." + }, + { + "value": "uk-ua", + "name": "UkUa", + "description": "Query language value for Ukrainian (Ukraine)." + }, + { + "value": "lv-lv", + "name": "LvLv", + "description": "Query language value for Latvian (Latvia)." + }, + { + "value": "et-ee", + "name": "EtEe", + "description": "Query language value for Estonian (Estonia)." + }, + { + "value": "ca-es", + "name": "CaEs", + "description": "Query language value for Catalan (Spain)." + }, + { + "value": "fi-fi", + "name": "FiFi", + "description": "Query language value for Finnish (Finland)." + }, + { + "value": "sr-ba", + "name": "SrBa", + "description": "Query language value for Serbian (Bosnia and Herzegovina)." + }, + { + "value": "sr-me", + "name": "SrMe", + "description": "Query language value for Serbian (Montenegro)." + }, + { + "value": "sr-rs", + "name": "SrRs", + "description": "Query language value for Serbian (Serbia)." + }, + { + "value": "sk-sk", + "name": "SkSk", + "description": "Query language value for Slovak (Slovakia)." + }, + { + "value": "nb-no", + "name": "NbNo", + "description": "Query language value for Norwegian (Norway)." + }, + { + "value": "hy-am", + "name": "HyAm", + "description": "Query language value for Armenian (Armenia)." + }, + { + "value": "bn-in", + "name": "BnIn", + "description": "Query language value for Bengali (India)." + }, + { + "value": "eu-es", + "name": "EuEs", + "description": "Query language value for Basque (Spain)." + }, + { + "value": "gl-es", + "name": "GlEs", + "description": "Query language value for Galician (Spain)." + }, + { + "value": "gu-in", + "name": "GuIn", + "description": "Query language value for Gujarati (India)." + }, + { + "value": "he-il", + "name": "HeIl", + "description": "Query language value for Hebrew (Israel)." + }, + { + "value": "ga-ie", + "name": "GaIe", + "description": "Query language value for Irish (Ireland)." + }, + { + "value": "kn-in", + "name": "KnIn", + "description": "Query language value for Kannada (India)." + }, + { + "value": "ml-in", + "name": "MlIn", + "description": "Query language value for Malayalam (India)." + }, + { + "value": "mr-in", + "name": "MrIn", + "description": "Query language value for Marathi (India)." + }, + { + "value": "fa-ae", + "name": "FaAe", + "description": "Query language value for Persian (U.A.E.)." + }, + { + "value": "pa-in", + "name": "PaIn", + "description": "Query language value for Punjabi (India)." + }, + { + "value": "te-in", + "name": "TeIn", + "description": "Query language value for Telugu (India)." + }, + { + "value": "ur-pk", + "name": "UrPk", + "description": "Query language value for Urdu (Pakistan)." + } + ] + }, + "description": "The language of the query." + }, + "ScoringStatistics": { + "type": "string", + "enum": [ + "local", + "global" + ], + "x-ms-enum": { + "name": "ScoringStatistics", + "modelAsString": false, + "values": [ + { + "value": "local", + "name": "Local", + "description": "The scoring statistics will be calculated locally for lower latency." + }, + { + "value": "global", + "name": "Global", + "description": "The scoring statistics will be calculated globally for more consistent scoring." + } + ] + }, + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries." + }, + "AutocompleteMode": { + "type": "string", + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms." + }, + "SearchRequest": { + "properties": { + "count": { + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-ms-client-name": "IncludeTotalResultCount" + }, + "facets": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "The OData $filter expression to apply to the search query." + }, + "highlight": { + "type": "string", + "description": "The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "queryType": { + "$ref": "#/definitions/QueryType", + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "scoringStatistics": { + "$ref": "#/definitions/ScoringStatistics", + "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries." + }, + "sessionId": { + "type": "string", + "description": "A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character." + }, + "scoringParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes)." + }, + "scoringProfile": { + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results." + }, + "semanticConfiguration": { + "type": "string", + "description": "The name of a semantic configuration that will be used when processing documents for queries of type semantic." + }, + "semanticErrorHandling": { + "$ref": "#/definitions/SemanticErrorHandling", + "description": "Allows the user to choose whether a semantic call should fail completely (default / current behavior), or to return partial results." + }, + "semanticMaxWaitInMilliseconds": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 700, + "description": "Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails." + }, + "debug": { + "$ref": "#/definitions/QueryDebugMode", + "description": "Enables a debugging tool that can be used to further explore your Semantic search results." + }, + "search": { + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter." + }, + "searchMode": { + "$ref": "#/definitions/SearchMode", + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "queryLanguage": { + "$ref": "#/definitions/QueryLanguage", + "description": "A value that specifies the language of the search query." + }, + "speller": { + "$ref": "#/definitions/Speller", + "description": "A value that specified the type of the speller to use to spell-correct individual search query terms." + }, + "answers": { + "$ref": "#/definitions/Answers", + "description": "A value that specifies whether answers should be returned as part of the search response." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included." + }, + "skip": { + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results." + }, + "captions": { + "$ref": "#/definitions/Captions", + "description": "A value that specifies whether captions should be returned as part of the search response." + }, + "semanticFields": { + "type": "string", + "description": "The comma-separated list of field names used for semantic search." + }, + "vector": { + "$ref": "#/definitions/Vector", + "description": "The query parameters for vector and hybrid search queries." + } + }, + "description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors." + }, + "SuggestRequest": { + "properties": { + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "search": { + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to search for the specified search text. Target fields must be included in the specified suggester." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors." + }, + "AutocompleteRequest": { + "properties": { + "search": { + "type": "string", + "description": "The search text on which to base autocomplete results.", + "x-ms-client-name": "SearchText" + }, + "autocompleteMode": { + "$ref": "#/definitions/AutocompleteMode", + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for fuzzy matching, and other autocomplete query behaviors." + }, + "AutocompleteResult": { + "properties": { + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request." + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AutocompleteItem" + }, + "description": "The list of returned Autocompleted items.", + "x-ms-client-name": "Results" + } + }, + "required": [ + "value" + ], + "description": "The result of Autocomplete query." + }, + "AutocompleteItem": { + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "The completed term." + }, + "queryPlusText": { + "type": "string", + "readOnly": true, + "description": "The query along with the completed term." + } + }, + "required": [ + "text", + "queryPlusText" + ], + "description": "The result of Autocomplete requests." + }, + "SearchError": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "A human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchError" + }, + "readOnly": true, + "description": "An array of details about specific errors that led to this reported error." + } + }, + "required": [ + "message" + ], + "description": "Describes an error condition for the Azure Cognitive Search API." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + }, + "IndexNameParameter": { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": false, + "description": "The name of the index.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json new file mode 100644 index 000000000000..228c428e2c22 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2023-07-01-Preview/searchservice.json @@ -0,0 +1,11596 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchServiceClient", + "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.", + "version": "2023-07-01-Preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/datasources('{dataSourceName}')": { + "put": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateDataSource": { + "$ref": "./examples/SearchServiceCreateOrUpdateDataSource.json" + } + }, + "description": "Creates a new datasource or updates a datasource if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to create or update." + }, + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Delete", + "x-ms-examples": { + "SearchServiceDeleteDataSource": { + "$ref": "./examples/SearchServiceDeleteDataSource.json" + } + }, + "description": "Deletes a datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Get", + "x-ms-examples": { + "SearchServiceGetDataSource": { + "$ref": "./examples/SearchServiceGetDataSource.json" + } + }, + "description": "Retrieves a datasource definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/datasources": { + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_List", + "x-ms-examples": { + "SearchServiceListDataSources": { + "$ref": "./examples/SearchServiceListDataSources.json" + } + }, + "description": "Lists all datasources available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the data sources to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListDataSourcesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Create", + "x-ms-examples": { + "SearchServiceCreateDataSource": { + "$ref": "./examples/SearchServiceCreateDataSource.json" + } + }, + "description": "Creates a new datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "parameters": [ + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.reset": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Reset", + "x-ms-examples": { + "SearchServiceResetIndexer": { + "$ref": "./examples/SearchServiceResetIndexer.json" + } + }, + "description": "Resets the change tracking state associated with an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.resetdocs": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_ResetDocs", + "x-ms-examples": { + "SearchServiceResetDocs": { + "$ref": "./examples/SearchServiceResetDocs.json" + } + }, + "description": "Resets specific documents in the datasource to be selectively re-ingested by the indexer.", + "externalDocs": { + "url": "https://aka.ms/reset-documents" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset documents for." + }, + { + "name": "keysOrIds", + "in": "body", + "required": false, + "schema": { + "type": "object", + "x-ms-client-name": "DocumentKeysOrIds", + "properties": { + "documentKeys": { + "type": "array", + "items": { + "type": "string" + }, + "description": "document keys to be reset" + }, + "datasourceDocumentIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "datasource document identifiers to be reset" + } + } + } + }, + { + "name": "overwrite", + "in": "query", + "required": false, + "default": false, + "type": "boolean", + "description": "If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.run": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Run", + "x-ms-examples": { + "SearchServiceRunIndexer": { + "$ref": "./examples/SearchServiceRunIndexer.json" + } + }, + "description": "Runs an indexer on-demand.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to run." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "202": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')": { + "put": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndexer": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndexer.json" + } + }, + "description": "Creates a new indexer or updates an indexer if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to create or update." + }, + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + }, + { + "$ref": "#/parameters/DisableCacheReprocessingChangeDetectionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndexer": { + "$ref": "./examples/SearchServiceDeleteIndexer.json" + } + }, + "description": "Deletes an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "404": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Get", + "x-ms-examples": { + "SearchServiceGetIndexer": { + "$ref": "./examples/SearchServiceGetIndexer.json" + } + }, + "description": "Retrieves an indexer definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_List", + "x-ms-examples": { + "SearchServiceListIndexers": { + "$ref": "./examples/SearchServiceListIndexers.json" + } + }, + "description": "Lists all indexers available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexers" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexersResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Create", + "x-ms-examples": { + "SearchServiceCreateIndexer": { + "$ref": "./examples/SearchServiceCreateIndexer.json" + } + }, + "description": "Creates a new indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.status": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_GetStatus", + "x-ms-examples": { + "SearchServiceGetIndexerStatus": { + "$ref": "./examples/SearchServiceGetIndexerStatus.json" + } + }, + "description": "Returns the current status and execution history of an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer for which to retrieve status." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerStatus" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/skillsets('{skillsetName}')": { + "put": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSkillset": { + "$ref": "./examples/SearchServiceCreateOrUpdateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service or updates the skillset if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/update-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to create or update." + }, + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create or update in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/IgnoreResetRequirementsParameter" + }, + { + "$ref": "#/parameters/DisableCacheReprocessingChangeDetectionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully updated.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Delete", + "x-ms-examples": { + "SearchServiceDeleteSkillset": { + "$ref": "./examples/SearchServiceDeleteSkillset.json" + } + }, + "description": "Deletes a skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/delete-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skillset is successfully deleted." + }, + "404": { + "description": "The provided skillset name is not found." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Get", + "x-ms-examples": { + "SearchServiceGetSkillset": { + "$ref": "./examples/SearchServiceGetSkillset.json" + } + }, + "description": "Retrieves a skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/get-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully returned.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/skillsets": { + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_List", + "x-ms-examples": { + "SearchServiceListSkillsets": { + "$ref": "./examples/SearchServiceListSkillsets.json" + } + }, + "description": "List all skillsets in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/list-skillset" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The list is successfully returned.", + "schema": { + "$ref": "#/definitions/ListSkillsetsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Create", + "x-ms-examples": { + "SearchServiceCreateSkillset": { + "$ref": "./examples/SearchServiceCreateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-skillset" + }, + "parameters": [ + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/skillsets('{skillsetName}')/search.resetskills": { + "post": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_ResetSkills", + "x-ms-examples": { + "SearchServiceResetSkills": { + "$ref": "./examples/SearchServiceResetSkills.json" + } + }, + "description": "Reset an existing skillset in a search service.", + "externalDocs": { + "url": "https://aka.ms/reset-skills" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to reset." + }, + { + "name": "skillNames", + "in": "body", + "required": true, + "schema": { + "type": "object", + "x-ms-client-name": "SkillNames", + "properties": { + "skillNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "the names of skills to be reset." + } + } + }, + "description": "The names of skills to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skills in the skillset are successfully reset." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/synonymmaps('{synonymMapName}')": { + "put": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSynonymMap": { + "$ref": "./examples/SearchServiceCreateOrUpdateSynonymMap.json" + } + }, + "description": "Creates a new synonym map or updates a synonym map if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to create or update." + }, + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Delete", + "x-ms-examples": { + "SearchServiceDeleteSynonymMap": { + "$ref": "./examples/SearchServiceDeleteSynonymMap.json" + } + }, + "description": "Deletes a synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Get", + "x-ms-examples": { + "SearchServiceGetSynonymMap": { + "$ref": "./examples/SearchServiceGetSynonymMap.json" + } + }, + "description": "Retrieves a synonym map definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/synonymmaps": { + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_List", + "x-ms-examples": { + "SearchServiceListSynonymMaps": { + "$ref": "./examples/SearchServiceListSynonymMaps.json" + } + }, + "description": "Lists all synonym maps available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Synonym-Maps" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListSynonymMapsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Create", + "x-ms-examples": { + "SearchServiceCreateSynonymMap": { + "$ref": "./examples/SearchServiceCreateSynonymMap.json" + } + }, + "description": "Creates a new synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Create", + "x-ms-examples": { + "SearchServiceCreateIndex": { + "$ref": "./examples/SearchServiceCreateIndex.json" + } + }, + "description": "Creates a new search index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "parameters": [ + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_List", + "x-ms-examples": { + "SearchServiceListIndexes": { + "$ref": "./examples/SearchServiceListIndexes.json" + } + }, + "description": "Lists all indexes available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexes" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/indexes('{indexName}')": { + "put": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndex": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndex.json" + } + }, + "description": "Creates a new search index or updates an index if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the index to create or update." + }, + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create or update." + }, + { + "name": "allowIndexDowntime", + "in": "query", + "required": false, + "type": "boolean", + "description": "Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndex": { + "$ref": "./examples/SearchServiceDeleteIndex.json" + } + }, + "description": "Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Get", + "x-ms-examples": { + "SearchServiceGetIndex": { + "$ref": "./examples/SearchServiceGetIndex.json" + } + }, + "description": "Retrieves an index definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes('{indexName}')/search.stats": { + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_GetStatistics", + "x-ms-examples": { + "SearchServiceGetIndexStatistics": { + "$ref": "./examples/SearchServiceGetIndexStatistics.json" + } + }, + "description": "Returns statistics for the given index, including a document count and storage usage.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to retrieve statistics." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GetIndexStatisticsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes('{indexName}')/search.analyze": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Analyze", + "x-ms-examples": { + "SearchServiceIndexAnalyze": { + "$ref": "./examples/SearchServiceIndexAnalyze.json" + } + }, + "description": "Shows how an analyzer breaks text into tokens.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/test-analyzer" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to test an analyzer." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeRequest" + }, + "description": "The text and analyzer or analysis components to test." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AnalyzeResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/aliases": { + "post": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_Create", + "x-ms-examples": { + "SearchServiceCreateAlias": { + "$ref": "./examples/SearchServiceCreateAlias.json" + } + }, + "description": "Creates a new search alias.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Alias" + }, + "parameters": [ + { + "name": "alias", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchAlias" + }, + "description": "The definition of the alias to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_List", + "x-ms-examples": { + "SearchServiceListAliases": { + "$ref": "./examples/SearchServiceListAliases.json" + } + }, + "description": "Lists all aliases available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Aliases" + }, + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListAliasesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/aliases('{aliasName}')": { + "put": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateAlias": { + "$ref": "./examples/SearchServiceCreateOrUpdateAlias.json" + } + }, + "description": "Creates a new search alias or updates an alias if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Alias" + }, + "parameters": [ + { + "name": "aliasName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the alias to create or update." + }, + { + "name": "alias", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchAlias" + }, + "description": "The definition of the alias to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_Delete", + "x-ms-examples": { + "SearchServiceDeleteAlias": { + "$ref": "./examples/SearchServiceDeleteAlias.json" + } + }, + "description": "Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Alias" + }, + "parameters": [ + { + "name": "aliasName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the alias to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Aliases" + ], + "operationId": "Aliases_Get", + "x-ms-examples": { + "SearchServiceGetAlias": { + "$ref": "./examples/SearchServiceGetAlias.json" + } + }, + "description": "Retrieves an alias definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Alias" + }, + "parameters": [ + { + "name": "aliasName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the alias to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchAlias" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/servicestats": { + "get": { + "tags": [ + "Service" + ], + "operationId": "GetServiceStatistics", + "x-ms-examples": { + "SearchServiceGetServiceStatistics": { + "$ref": "./examples/SearchServiceGetServiceStatistics.json" + } + }, + "description": "Gets service level statistics for a search service.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ServiceStatistics" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + } + }, + "definitions": { + "AnalyzeRequest": { + "properties": { + "text": { + "type": "string", + "description": "The text to break into tokens." + }, + "analyzer": { + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use to break the given text." + }, + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to break the given text." + }, + "normalizer": { + "$ref": "#/definitions/LexicalNormalizerName", + "description": "The name of the normalizer to use to normalize the given text." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "An optional list of token filters to use when breaking the given text." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "An optional list of character filters to use when breaking the given text." + } + }, + "required": [ + "text" + ], + "description": "Specifies some text and analysis components used to break that text into tokens." + }, + "AnalyzeResult": { + "properties": { + "tokens": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzedTokenInfo" + }, + "description": "The list of tokens returned by the analyzer specified in the request." + } + }, + "required": [ + "tokens" + ], + "description": "The result of testing an analyzer on text." + }, + "AnalyzedTokenInfo": { + "properties": { + "token": { + "type": "string", + "readOnly": true, + "description": "The token returned by the analyzer." + }, + "startOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the first character of the token in the input text." + }, + "endOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the last character of the token in the input text." + }, + "position": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other." + } + }, + "required": [ + "token", + "startOffset", + "endOffset", + "position" + ], + "description": "Information about a token returned by an analyzer." + }, + "LexicalAnalyzerName": { + "type": "string", + "enum": [ + "ar.microsoft", + "ar.lucene", + "hy.lucene", + "bn.microsoft", + "eu.lucene", + "bg.microsoft", + "bg.lucene", + "ca.microsoft", + "ca.lucene", + "zh-Hans.microsoft", + "zh-Hans.lucene", + "zh-Hant.microsoft", + "zh-Hant.lucene", + "hr.microsoft", + "cs.microsoft", + "cs.lucene", + "da.microsoft", + "da.lucene", + "nl.microsoft", + "nl.lucene", + "en.microsoft", + "en.lucene", + "et.microsoft", + "fi.microsoft", + "fi.lucene", + "fr.microsoft", + "fr.lucene", + "gl.lucene", + "de.microsoft", + "de.lucene", + "el.microsoft", + "el.lucene", + "gu.microsoft", + "he.microsoft", + "hi.microsoft", + "hi.lucene", + "hu.microsoft", + "hu.lucene", + "is.microsoft", + "id.microsoft", + "id.lucene", + "ga.lucene", + "it.microsoft", + "it.lucene", + "ja.microsoft", + "ja.lucene", + "kn.microsoft", + "ko.microsoft", + "ko.lucene", + "lv.microsoft", + "lv.lucene", + "lt.microsoft", + "ml.microsoft", + "ms.microsoft", + "mr.microsoft", + "nb.microsoft", + "no.lucene", + "fa.lucene", + "pl.microsoft", + "pl.lucene", + "pt-BR.microsoft", + "pt-BR.lucene", + "pt-PT.microsoft", + "pt-PT.lucene", + "pa.microsoft", + "ro.microsoft", + "ro.lucene", + "ru.microsoft", + "ru.lucene", + "sr-cyrillic.microsoft", + "sr-latin.microsoft", + "sk.microsoft", + "sl.microsoft", + "es.microsoft", + "es.lucene", + "sv.microsoft", + "sv.lucene", + "ta.microsoft", + "te.microsoft", + "th.microsoft", + "th.lucene", + "tr.microsoft", + "tr.lucene", + "uk.microsoft", + "ur.microsoft", + "vi.microsoft", + "standard.lucene", + "standardasciifolding.lucene", + "keyword", + "pattern", + "simple", + "stop", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalAnalyzerName", + "modelAsString": true, + "values": [ + { + "value": "ar.microsoft", + "name": "ArMicrosoft", + "description": "Microsoft analyzer for Arabic." + }, + { + "value": "ar.lucene", + "name": "ArLucene", + "description": "Lucene analyzer for Arabic." + }, + { + "value": "hy.lucene", + "name": "HyLucene", + "description": "Lucene analyzer for Armenian." + }, + { + "value": "bn.microsoft", + "name": "BnMicrosoft", + "description": "Microsoft analyzer for Bangla." + }, + { + "value": "eu.lucene", + "name": "EuLucene", + "description": "Lucene analyzer for Basque." + }, + { + "value": "bg.microsoft", + "name": "BgMicrosoft", + "description": "Microsoft analyzer for Bulgarian." + }, + { + "value": "bg.lucene", + "name": "BgLucene", + "description": "Lucene analyzer for Bulgarian." + }, + { + "value": "ca.microsoft", + "name": "CaMicrosoft", + "description": "Microsoft analyzer for Catalan." + }, + { + "value": "ca.lucene", + "name": "CaLucene", + "description": "Lucene analyzer for Catalan." + }, + { + "value": "zh-Hans.microsoft", + "name": "ZhHansMicrosoft", + "description": "Microsoft analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hans.lucene", + "name": "ZhHansLucene", + "description": "Lucene analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hant.microsoft", + "name": "ZhHantMicrosoft", + "description": "Microsoft analyzer for Chinese (Traditional)." + }, + { + "value": "zh-Hant.lucene", + "name": "ZhHantLucene", + "description": "Lucene analyzer for Chinese (Traditional)." + }, + { + "value": "hr.microsoft", + "name": "HrMicrosoft", + "description": "Microsoft analyzer for Croatian." + }, + { + "value": "cs.microsoft", + "name": "CsMicrosoft", + "description": "Microsoft analyzer for Czech." + }, + { + "value": "cs.lucene", + "name": "CsLucene", + "description": "Lucene analyzer for Czech." + }, + { + "value": "da.microsoft", + "name": "DaMicrosoft", + "description": "Microsoft analyzer for Danish." + }, + { + "value": "da.lucene", + "name": "DaLucene", + "description": "Lucene analyzer for Danish." + }, + { + "value": "nl.microsoft", + "name": "NlMicrosoft", + "description": "Microsoft analyzer for Dutch." + }, + { + "value": "nl.lucene", + "name": "NlLucene", + "description": "Lucene analyzer for Dutch." + }, + { + "value": "en.microsoft", + "name": "EnMicrosoft", + "description": "Microsoft analyzer for English." + }, + { + "value": "en.lucene", + "name": "EnLucene", + "description": "Lucene analyzer for English." + }, + { + "value": "et.microsoft", + "name": "EtMicrosoft", + "description": "Microsoft analyzer for Estonian." + }, + { + "value": "fi.microsoft", + "name": "FiMicrosoft", + "description": "Microsoft analyzer for Finnish." + }, + { + "value": "fi.lucene", + "name": "FiLucene", + "description": "Lucene analyzer for Finnish." + }, + { + "value": "fr.microsoft", + "name": "FrMicrosoft", + "description": "Microsoft analyzer for French." + }, + { + "value": "fr.lucene", + "name": "FrLucene", + "description": "Lucene analyzer for French." + }, + { + "value": "gl.lucene", + "name": "GlLucene", + "description": "Lucene analyzer for Galician." + }, + { + "value": "de.microsoft", + "name": "DeMicrosoft", + "description": "Microsoft analyzer for German." + }, + { + "value": "de.lucene", + "name": "DeLucene", + "description": "Lucene analyzer for German." + }, + { + "value": "el.microsoft", + "name": "ElMicrosoft", + "description": "Microsoft analyzer for Greek." + }, + { + "value": "el.lucene", + "name": "ElLucene", + "description": "Lucene analyzer for Greek." + }, + { + "value": "gu.microsoft", + "name": "GuMicrosoft", + "description": "Microsoft analyzer for Gujarati." + }, + { + "value": "he.microsoft", + "name": "HeMicrosoft", + "description": "Microsoft analyzer for Hebrew." + }, + { + "value": "hi.microsoft", + "name": "HiMicrosoft", + "description": "Microsoft analyzer for Hindi." + }, + { + "value": "hi.lucene", + "name": "HiLucene", + "description": "Lucene analyzer for Hindi." + }, + { + "value": "hu.microsoft", + "name": "HuMicrosoft", + "description": "Microsoft analyzer for Hungarian." + }, + { + "value": "hu.lucene", + "name": "HuLucene", + "description": "Lucene analyzer for Hungarian." + }, + { + "value": "is.microsoft", + "name": "IsMicrosoft", + "description": "Microsoft analyzer for Icelandic." + }, + { + "value": "id.microsoft", + "name": "IdMicrosoft", + "description": "Microsoft analyzer for Indonesian (Bahasa)." + }, + { + "value": "id.lucene", + "name": "IdLucene", + "description": "Lucene analyzer for Indonesian." + }, + { + "value": "ga.lucene", + "name": "GaLucene", + "description": "Lucene analyzer for Irish." + }, + { + "value": "it.microsoft", + "name": "ItMicrosoft", + "description": "Microsoft analyzer for Italian." + }, + { + "value": "it.lucene", + "name": "ItLucene", + "description": "Lucene analyzer for Italian." + }, + { + "value": "ja.microsoft", + "name": "JaMicrosoft", + "description": "Microsoft analyzer for Japanese." + }, + { + "value": "ja.lucene", + "name": "JaLucene", + "description": "Lucene analyzer for Japanese." + }, + { + "value": "kn.microsoft", + "name": "KnMicrosoft", + "description": "Microsoft analyzer for Kannada." + }, + { + "value": "ko.microsoft", + "name": "KoMicrosoft", + "description": "Microsoft analyzer for Korean." + }, + { + "value": "ko.lucene", + "name": "KoLucene", + "description": "Lucene analyzer for Korean." + }, + { + "value": "lv.microsoft", + "name": "LvMicrosoft", + "description": "Microsoft analyzer for Latvian." + }, + { + "value": "lv.lucene", + "name": "LvLucene", + "description": "Lucene analyzer for Latvian." + }, + { + "value": "lt.microsoft", + "name": "LtMicrosoft", + "description": "Microsoft analyzer for Lithuanian." + }, + { + "value": "ml.microsoft", + "name": "MlMicrosoft", + "description": "Microsoft analyzer for Malayalam." + }, + { + "value": "ms.microsoft", + "name": "MsMicrosoft", + "description": "Microsoft analyzer for Malay (Latin)." + }, + { + "value": "mr.microsoft", + "name": "MrMicrosoft", + "description": "Microsoft analyzer for Marathi." + }, + { + "value": "nb.microsoft", + "name": "NbMicrosoft", + "description": "Microsoft analyzer for Norwegian (Bokmål)." + }, + { + "value": "no.lucene", + "name": "NoLucene", + "description": "Lucene analyzer for Norwegian." + }, + { + "value": "fa.lucene", + "name": "FaLucene", + "description": "Lucene analyzer for Persian." + }, + { + "value": "pl.microsoft", + "name": "PlMicrosoft", + "description": "Microsoft analyzer for Polish." + }, + { + "value": "pl.lucene", + "name": "PlLucene", + "description": "Lucene analyzer for Polish." + }, + { + "value": "pt-BR.microsoft", + "name": "PtBrMicrosoft", + "description": "Microsoft analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-BR.lucene", + "name": "PtBrLucene", + "description": "Lucene analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-PT.microsoft", + "name": "PtPtMicrosoft", + "description": "Microsoft analyzer for Portuguese (Portugal)." + }, + { + "value": "pt-PT.lucene", + "name": "PtPtLucene", + "description": "Lucene analyzer for Portuguese (Portugal)." + }, + { + "value": "pa.microsoft", + "name": "PaMicrosoft", + "description": "Microsoft analyzer for Punjabi." + }, + { + "value": "ro.microsoft", + "name": "RoMicrosoft", + "description": "Microsoft analyzer for Romanian." + }, + { + "value": "ro.lucene", + "name": "RoLucene", + "description": "Lucene analyzer for Romanian." + }, + { + "value": "ru.microsoft", + "name": "RuMicrosoft", + "description": "Microsoft analyzer for Russian." + }, + { + "value": "ru.lucene", + "name": "RuLucene", + "description": "Lucene analyzer for Russian." + }, + { + "value": "sr-cyrillic.microsoft", + "name": "SrCyrillicMicrosoft", + "description": "Microsoft analyzer for Serbian (Cyrillic)." + }, + { + "value": "sr-latin.microsoft", + "name": "SrLatinMicrosoft", + "description": "Microsoft analyzer for Serbian (Latin)." + }, + { + "value": "sk.microsoft", + "name": "SkMicrosoft", + "description": "Microsoft analyzer for Slovak." + }, + { + "value": "sl.microsoft", + "name": "SlMicrosoft", + "description": "Microsoft analyzer for Slovenian." + }, + { + "value": "es.microsoft", + "name": "EsMicrosoft", + "description": "Microsoft analyzer for Spanish." + }, + { + "value": "es.lucene", + "name": "EsLucene", + "description": "Lucene analyzer for Spanish." + }, + { + "value": "sv.microsoft", + "name": "SvMicrosoft", + "description": "Microsoft analyzer for Swedish." + }, + { + "value": "sv.lucene", + "name": "SvLucene", + "description": "Lucene analyzer for Swedish." + }, + { + "value": "ta.microsoft", + "name": "TaMicrosoft", + "description": "Microsoft analyzer for Tamil." + }, + { + "value": "te.microsoft", + "name": "TeMicrosoft", + "description": "Microsoft analyzer for Telugu." + }, + { + "value": "th.microsoft", + "name": "ThMicrosoft", + "description": "Microsoft analyzer for Thai." + }, + { + "value": "th.lucene", + "name": "ThLucene", + "description": "Lucene analyzer for Thai." + }, + { + "value": "tr.microsoft", + "name": "TrMicrosoft", + "description": "Microsoft analyzer for Turkish." + }, + { + "value": "tr.lucene", + "name": "TrLucene", + "description": "Lucene analyzer for Turkish." + }, + { + "value": "uk.microsoft", + "name": "UkMicrosoft", + "description": "Microsoft analyzer for Ukrainian." + }, + { + "value": "ur.microsoft", + "name": "UrMicrosoft", + "description": "Microsoft analyzer for Urdu." + }, + { + "value": "vi.microsoft", + "name": "ViMicrosoft", + "description": "Microsoft analyzer for Vietnamese." + }, + { + "value": "standard.lucene", + "name": "StandardLucene", + "description": "Standard Lucene analyzer." + }, + { + "value": "standardasciifolding.lucene", + "name": "StandardAsciiFoldingLucene", + "description": "Standard ASCII Folding Lucene analyzer. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers" + }, + { + "value": "keyword", + "name": "Keyword", + "description": "Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + }, + { + "value": "simple", + "name": "Simple", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html" + }, + { + "value": "stop", + "name": "Stop", + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html" + } + ] + }, + "description": "Defines the names of all text analyzers supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + } + }, + "LexicalTokenizerName": { + "type": "string", + "enum": [ + "classic", + "edgeNGram", + "keyword_v2", + "letter", + "lowercase", + "microsoft_language_tokenizer", + "microsoft_language_stemming_tokenizer", + "nGram", + "path_hierarchy_v2", + "pattern", + "standard_v2", + "uax_url_email", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalTokenizerName", + "modelAsString": true, + "values": [ + { + "value": "classic", + "name": "Classic", + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + }, + { + "value": "edgeNGram", + "name": "EdgeNGram", + "description": "Tokenizes the input from an edge into n-grams of the given size(s). See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + }, + { + "value": "keyword_v2", + "name": "Keyword", + "description": "Emits the entire input as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + { + "value": "letter", + "name": "Letter", + "description": "Divides text at non-letters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html" + }, + { + "value": "microsoft_language_tokenizer", + "name": "MicrosoftLanguageTokenizer", + "description": "Divides text using language-specific rules." + }, + { + "value": "microsoft_language_stemming_tokenizer", + "name": "MicrosoftLanguageStemmingTokenizer", + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + { + "value": "nGram", + "name": "NGram", + "description": "Tokenizes the input into n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + }, + { + "value": "path_hierarchy_v2", + "name": "PathHierarchy", + "description": "Tokenizer for path-like hierarchies. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + }, + { + "value": "standard_v2", + "name": "Standard", + "description": "Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + { + "value": "uax_url_email", + "name": "UaxUrlEmail", + "description": "Tokenizes urls and emails as one token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Divides text at whitespace. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html" + } + ] + }, + "description": "Defines the names of all tokenizers supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "TokenFilterName": { + "type": "string", + "enum": [ + "arabic_normalization", + "apostrophe", + "asciifolding", + "cjk_bigram", + "cjk_width", + "classic", + "common_grams", + "edgeNGram_v2", + "elision", + "german_normalization", + "hindi_normalization", + "indic_normalization", + "keyword_repeat", + "kstem", + "length", + "limit", + "lowercase", + "nGram_v2", + "persian_normalization", + "phonetic", + "porter_stem", + "reverse", + "scandinavian_normalization", + "scandinavian_folding", + "shingle", + "snowball", + "sorani_normalization", + "stemmer", + "stopwords", + "trim", + "truncate", + "unique", + "uppercase", + "word_delimiter" + ], + "x-ms-enum": { + "name": "TokenFilterName", + "modelAsString": true, + "values": [ + { + "value": "arabic_normalization", + "name": "ArabicNormalization", + "description": "A token filter that applies the Arabic normalizer to normalize the orthography. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html" + }, + { + "value": "apostrophe", + "name": "Apostrophe", + "description": "Strips all characters after an apostrophe (including the apostrophe itself). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html" + }, + { + "value": "asciifolding", + "name": "AsciiFolding", + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + }, + { + "value": "cjk_bigram", + "name": "CjkBigram", + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + }, + { + "value": "cjk_width", + "name": "CjkWidth", + "description": "Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html" + }, + { + "value": "classic", + "name": "Classic", + "description": "Removes English possessives, and dots from acronyms. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html" + }, + { + "value": "common_grams", + "name": "CommonGram", + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + }, + { + "value": "edgeNGram_v2", + "name": "EdgeNGram", + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + { + "value": "elision", + "name": "Elision", + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + }, + { + "value": "german_normalization", + "name": "GermanNormalization", + "description": "Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html" + }, + { + "value": "hindi_normalization", + "name": "HindiNormalization", + "description": "Normalizes text in Hindi to remove some differences in spelling variations. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html" + }, + { + "value": "indic_normalization", + "name": "IndicNormalization", + "description": "Normalizes the Unicode representation of text in Indian languages. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html" + }, + { + "value": "keyword_repeat", + "name": "KeywordRepeat", + "description": "Emits each incoming token twice, once as keyword and once as non-keyword. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html" + }, + { + "value": "kstem", + "name": "KStem", + "description": "A high-performance kstem filter for English. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html" + }, + { + "value": "length", + "name": "Length", + "description": "Removes words that are too long or too short. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + }, + { + "value": "limit", + "name": "Limit", + "description": "Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Normalizes token text to lower case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html" + }, + { + "value": "nGram_v2", + "name": "NGram", + "description": "Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + { + "value": "persian_normalization", + "name": "PersianNormalization", + "description": "Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html" + }, + { + "value": "phonetic", + "name": "Phonetic", + "description": "Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + }, + { + "value": "porter_stem", + "name": "PorterStem", + "description": "Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer" + }, + { + "value": "reverse", + "name": "Reverse", + "description": "Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" + }, + { + "value": "scandinavian_normalization", + "name": "ScandinavianNormalization", + "description": "Normalizes use of the interchangeable Scandinavian characters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html" + }, + { + "value": "scandinavian_folding", + "name": "ScandinavianFoldingNormalization", + "description": "Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html" + }, + { + "value": "shingle", + "name": "Shingle", + "description": "Creates combinations of tokens as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + }, + { + "value": "snowball", + "name": "Snowball", + "description": "A filter that stems words using a Snowball-generated stemmer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + }, + { + "value": "sorani_normalization", + "name": "SoraniNormalization", + "description": "Normalizes the Unicode representation of Sorani text. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html" + }, + { + "value": "stemmer", + "name": "Stemmer", + "description": "Language specific stemming filter. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + }, + { + "value": "stopwords", + "name": "Stopwords", + "description": "Removes stop words from a token stream. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + }, + { + "value": "trim", + "name": "Trim", + "description": "Trims leading and trailing whitespace from tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html" + }, + { + "value": "truncate", + "name": "Truncate", + "description": "Truncates the terms to a specific length. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + }, + { + "value": "unique", + "name": "Unique", + "description": "Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + }, + { + "value": "uppercase", + "name": "Uppercase", + "description": "Normalizes token text to upper case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" + }, + { + "value": "word_delimiter", + "name": "WordDelimiter", + "description": "Splits words into subwords and performs optional transformations on subword groups." + } + ] + }, + "description": "Defines the names of all token filters supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "LexicalNormalizerName": { + "type": "string", + "enum": [ + "asciifolding", + "elision", + "lowercase", + "standard", + "uppercase" + ], + "x-ms-enum": { + "name": "LexicalNormalizerName", + "modelAsString": true, + "values": [ + { + "value": "asciifolding", + "name": "AsciiFolding", + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + }, + { + "value": "elision", + "name": "Elision", + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html" + }, + { + "value": "standard", + "name": "Standard", + "description": "Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" + }, + { + "value": "uppercase", + "name": "Uppercase", + "description": "Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" + } + ] + }, + "description": "Defines the names of all text normalizers supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + } + }, + "CharFilterName": { + "type": "string", + "enum": [ + "html_strip" + ], + "x-ms-enum": { + "name": "CharFilterName", + "modelAsString": true, + "values": [ + { + "value": "html_strip", + "name": "HtmlStrip", + "description": "A character filter that attempts to strip out HTML constructs. See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html" + } + ] + }, + "description": "Defines the names of all character filters supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "RegexFlags": { + "type": "string", + "enum": [ + "CANON_EQ", + "CASE_INSENSITIVE", + "COMMENTS", + "DOTALL", + "LITERAL", + "MULTILINE", + "UNICODE_CASE", + "UNIX_LINES" + ], + "x-ms-enum": { + "name": "RegexFlags", + "modelAsString": true, + "values": [ + { + "value": "CANON_EQ", + "name": "CanonEq", + "description": "Enables canonical equivalence." + }, + { + "value": "CASE_INSENSITIVE", + "name": "CaseInsensitive", + "description": "Enables case-insensitive matching." + }, + { + "value": "COMMENTS", + "name": "Comments", + "description": "Permits whitespace and comments in the pattern." + }, + { + "value": "DOTALL", + "name": "DotAll", + "description": "Enables dotall mode." + }, + { + "value": "LITERAL", + "name": "Literal", + "description": "Enables literal parsing of the pattern." + }, + { + "value": "MULTILINE", + "name": "Multiline", + "description": "Enables multiline mode." + }, + { + "value": "UNICODE_CASE", + "name": "UnicodeCase", + "description": "Enables Unicode-aware case folding." + }, + { + "value": "UNIX_LINES", + "name": "UnixLines", + "description": "Enables Unix lines mode." + } + ] + }, + "description": "Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.", + "externalDocs": { + "url": "http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#field_summary" + } + }, + "SearchFieldDataType": { + "type": "string", + "enum": [ + "Edm.String", + "Edm.Int32", + "Edm.Int64", + "Edm.Double", + "Edm.Boolean", + "Edm.DateTimeOffset", + "Edm.GeographyPoint", + "Edm.ComplexType", + "Edm.Single" + ], + "x-ms-enum": { + "name": "SearchFieldDataType", + "modelAsString": true, + "values": [ + { + "value": "Edm.String", + "name": "String", + "description": "Indicates that a field contains a string." + }, + { + "value": "Edm.Int32", + "name": "Int32", + "description": "Indicates that a field contains a 32-bit signed integer." + }, + { + "value": "Edm.Int64", + "name": "Int64", + "description": "Indicates that a field contains a 64-bit signed integer." + }, + { + "value": "Edm.Double", + "name": "Double", + "description": "Indicates that a field contains an IEEE double-precision floating point number." + }, + { + "value": "Edm.Boolean", + "name": "Boolean", + "description": "Indicates that a field contains a Boolean value (true or false)." + }, + { + "value": "Edm.DateTimeOffset", + "name": "DateTimeOffset", + "description": "Indicates that a field contains a date/time value, including timezone information." + }, + { + "value": "Edm.GeographyPoint", + "name": "GeographyPoint", + "description": "Indicates that a field contains a geo-location in terms of longitude and latitude." + }, + { + "value": "Edm.ComplexType", + "name": "Complex", + "description": "Indicates that a field contains one or more complex objects that in turn have sub-fields of other types." + }, + { + "value": "Edm.Single", + "name": "Single", + "description": "Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single)." + } + ] + }, + "description": "Defines the data type of a field in a search index." + }, + "LexicalAnalyzer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the analyzer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for analyzers." + }, + "CustomAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "required": [ + "tokenizer" + ], + "description": "Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer." + }, + "PatternAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "lowercase": { + "x-ms-client-name": "LowerCaseTerms", + "type": "boolean", + "default": true, + "description": "A value indicating whether terms should be lower-cased. Default is true." + }, + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + } + }, + "LuceneStandardAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html" + } + }, + "StopAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + } + }, + "LexicalNormalizer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the normalizer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + }, + "description": "The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for normalizers." + }, + "CustomNormalizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomNormalizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalNormalizer" + } + ], + "properties": { + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the input token. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "description": "Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching. This is a user-defined configuration consisting of at least one or more filters, which modify the token that is stored.", + "externalDocs": { + "url": "https://aka.ms/azs-custom-normalizers" + } + }, + "LexicalTokenizer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the tokenizer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for tokenizers.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "ClassicTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + } + }, + "TokenCharacterKind": { + "type": "string", + "enum": [ + "letter", + "digit", + "whitespace", + "punctuation", + "symbol" + ], + "x-ms-enum": { + "name": "TokenCharacterKind", + "modelAsString": false, + "values": [ + { + "value": "letter", + "name": "Letter", + "description": "Keeps letters in tokens." + }, + { + "value": "digit", + "name": "Digit", + "description": "Keeps digits in tokens." + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Keeps whitespace in tokens." + }, + { + "value": "punctuation", + "name": "Punctuation", + "description": "Keeps punctuation in tokens." + }, + { + "value": "symbol", + "name": "Symbol", + "description": "Keeps symbols in tokens." + } + ] + }, + "description": "Represents classes of characters on which a token filter can operate." + }, + "EdgeNGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + } + }, + "KeywordTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "bufferSize": { + "type": "integer", + "format": "int32", + "default": 256, + "description": "The read buffer size in bytes. Default is 256." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "KeywordTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 256, + "maximum": 300, + "description": "The maximum token length. Default is 256. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + } + }, + "MicrosoftTokenizerLanguage": { + "type": "string", + "enum": [ + "bangla", + "bulgarian", + "catalan", + "chineseSimplified", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", + "english", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", + "indonesian", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", + "ukrainian", + "urdu", + "vietnamese" + ], + "x-ms-enum": { + "name": "MicrosoftTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft tokenizer for Catalan." + }, + { + "value": "chineseSimplified", + "name": "ChineseSimplified", + "description": "Selects the Microsoft tokenizer for Chinese (Simplified)." + }, + { + "value": "chineseTraditional", + "name": "ChineseTraditional", + "description": "Selects the Microsoft tokenizer for Chinese (Traditional)." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft tokenizer for English." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft tokenizer for Gujarati." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft tokenizer for Hindi." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft tokenizer for Italian." + }, + { + "value": "japanese", + "name": "Japanese", + "description": "Selects the Microsoft tokenizer for Japanese." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft tokenizer for Kannada." + }, + { + "value": "korean", + "name": "Korean", + "description": "Selects the Microsoft tokenizer for Korean." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft tokenizer for Serbian (Latin)." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft tokenizer for Telugu." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the Microsoft tokenizer for Thai." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft tokenizer for Urdu." + }, + { + "value": "vietnamese", + "name": "Vietnamese", + "description": "Selects the Microsoft tokenizer for Vietnamese." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language tokenizer." + }, + "MicrosoftLanguageTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules." + }, + "MicrosoftStemmingTokenizerLanguage": { + "type": "string", + "enum": [ + "arabic", + "bangla", + "bulgarian", + "catalan", + "croatian", + "czech", + "danish", + "dutch", + "english", + "estonian", + "finnish", + "french", + "german", + "greek", + "gujarati", + "hebrew", + "hindi", + "hungarian", + "icelandic", + "indonesian", + "italian", + "kannada", + "latvian", + "lithuanian", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovak", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "turkish", + "ukrainian", + "urdu" + ], + "x-ms-enum": { + "name": "MicrosoftStemmingTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Microsoft stemming tokenizer for Arabic." + }, + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft stemming tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft stemming tokenizer for Catalan." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft stemming tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft stemming tokenizer for English." + }, + { + "value": "estonian", + "name": "Estonian", + "description": "Selects the Microsoft stemming tokenizer for Estonian." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Microsoft stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft stemming tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft stemming tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft stemming tokenizer for Gujarati." + }, + { + "value": "hebrew", + "name": "Hebrew", + "description": "Selects the Microsoft stemming tokenizer for Hebrew." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Microsoft stemming tokenizer for Hungarian." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft stemming tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft stemming tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft stemming tokenizer for Italian." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft stemming tokenizer for Kannada." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Microsoft stemming tokenizer for Latvian." + }, + { + "value": "lithuanian", + "name": "Lithuanian", + "description": "Selects the Microsoft stemming tokenizer for Lithuanian." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft stemming tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft stemming tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft stemming tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft stemming tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft stemming tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft stemming tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft stemming tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Latin)." + }, + { + "value": "slovak", + "name": "Slovak", + "description": "Selects the Microsoft stemming tokenizer for Slovak." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft stemming tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft stemming tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft stemming tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft stemming tokenizer for Telugu." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Microsoft stemming tokenizer for Turkish." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft stemming tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft stemming tokenizer for Urdu." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language stemming tokenizer." + }, + "MicrosoftLanguageStemmingTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftStemmingTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + "NGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + } + }, + "PathHierarchyTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "delimiter": { + "type": "string", + "format": "char", + "default": "/", + "description": "The delimiter character to use. Default is \"/\"." + }, + "replacement": { + "type": "string", + "format": "char", + "default": "/", + "description": "A value that, if set, replaces the delimiter character. Default is \"/\"." + }, + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum token length. Default and maximum is 300." + }, + "reverse": { + "x-ms-client-name": "ReverseTokenOrder", + "type": "boolean", + "default": false, + "description": "A value indicating whether to generate tokens in reverse order. Default is false." + }, + "skip": { + "x-ms-client-name": "NumberOfTokensToSkip", + "type": "integer", + "format": "int32", + "default": 0, + "description": "The number of initial tokens to skip. Default is 0." + } + }, + "description": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + } + }, + "PatternTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "group": { + "type": "integer", + "format": "int32", + "default": -1, + "description": "The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1." + } + }, + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + } + }, + "LuceneStandardTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "LuceneStandardTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + } + }, + "UaxUrlEmailTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + } + }, + "TokenFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the token filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for token filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "AsciiFoldingTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether the original token will be kept. Default is false." + } + }, + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + } + }, + "CjkBigramTokenFilterScripts": { + "type": "string", + "enum": [ + "han", + "hiragana", + "katakana", + "hangul" + ], + "x-ms-enum": { + "name": "CjkBigramTokenFilterScripts", + "modelAsString": false, + "values": [ + { + "value": "han", + "name": "Han", + "description": "Ignore Han script when forming bigrams of CJK terms." + }, + { + "value": "hiragana", + "name": "Hiragana", + "description": "Ignore Hiragana script when forming bigrams of CJK terms." + }, + { + "value": "katakana", + "name": "Katakana", + "description": "Ignore Katakana script when forming bigrams of CJK terms." + }, + { + "value": "hangul", + "name": "Hangul", + "description": "Ignore Hangul script when forming bigrams of CJK terms." + } + ] + }, + "description": "Scripts that can be ignored by CjkBigramTokenFilter." + }, + "CjkBigramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CjkBigramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "ignoreScripts": { + "type": "array", + "items": { + "$ref": "#/definitions/CjkBigramTokenFilterScripts", + "x-nullable": false + }, + "description": "The scripts to ignore." + }, + "outputUnigrams": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false." + } + }, + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + } + }, + "CommonGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CommonGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "commonWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of common words." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether common words matching will be case insensitive. Default is false." + }, + "queryMode": { + "x-ms-client-name": "UseQueryMode", + "type": "boolean", + "default": false, + "description": "A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false." + } + }, + "required": [ + "commonWords" + ], + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + } + }, + "DictionaryDecompounderTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "wordList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to match against." + }, + "minWordSize": { + "type": "integer", + "format": "int32", + "default": 5, + "maximum": 300, + "description": "The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300." + }, + "minSubwordSize": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300." + }, + "maxSubwordSize": { + "type": "integer", + "format": "int32", + "default": 15, + "maximum": 300, + "description": "The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300." + }, + "onlyLongestMatch": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to add only the longest matching subword to the output. Default is false." + } + }, + "required": [ + "wordList" + ], + "description": "Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilter.html" + } + }, + "EdgeNGramTokenFilterSide": { + "type": "string", + "enum": [ + "front", + "back" + ], + "x-ms-enum": { + "name": "EdgeNGramTokenFilterSide", + "modelAsString": false, + "values": [ + { + "value": "front", + "name": "Front", + "description": "Specifies that the n-gram should be generated from the front of the input." + }, + { + "value": "back", + "name": "Back", + "description": "Specifies that the n-gram should be generated from the back of the input." + } + ] + }, + "description": "Specifies which side of the input an n-gram should be generated from." + }, + "EdgeNGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "EdgeNGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + } + }, + "ElisionTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ElisionTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "articles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of articles to remove." + } + }, + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + } + }, + "KeepTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeepTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keepWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to keep." + }, + "keepWordsCase": { + "x-ms-client-name": "LowerCaseKeepWords", + "type": "boolean", + "default": false, + "description": "A value indicating whether to lower case all words first. Default is false." + } + }, + "required": [ + "keepWords" + ], + "description": "A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeepWordFilter.html" + } + }, + "KeywordMarkerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordMarkerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of words to mark as keywords." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + } + }, + "required": [ + "keywords" + ], + "description": "Marks terms as keywords. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordMarkerFilter.html" + } + }, + "LengthTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LengthTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "min": { + "x-ms-client-name": "minLength", + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 300, + "description": "The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max." + }, + "max": { + "x-ms-client-name": "maxLength", + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum length in characters. Default and maximum is 300." + } + }, + "description": "Removes words that are too long or too short. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + } + }, + "LimitTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LimitTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxTokenCount": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The maximum number of tokens to produce. Default is 1." + }, + "consumeAllTokens": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false." + } + }, + "description": "Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + } + }, + "NGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "NGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + } + }, + "PatternCaptureTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternCaptureTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "patterns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of patterns to match against each token." + }, + "preserveOriginal": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to return the original token even if one of the patterns matches. Default is true." + } + }, + "required": [ + "patterns" + ], + "description": "Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternCaptureGroupTokenFilter.html" + } + }, + "PatternReplaceTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceFilter.html" + } + }, + "PhoneticEncoder": { + "type": "string", + "enum": [ + "metaphone", + "doubleMetaphone", + "soundex", + "refinedSoundex", + "caverphone1", + "caverphone2", + "cologne", + "nysiis", + "koelnerPhonetik", + "haasePhonetik", + "beiderMorse" + ], + "x-ms-enum": { + "name": "PhoneticEncoder", + "modelAsString": false, + "values": [ + { + "value": "metaphone", + "name": "Metaphone", + "description": "Encodes a token into a Metaphone value." + }, + { + "value": "doubleMetaphone", + "name": "DoubleMetaphone", + "description": "Encodes a token into a double metaphone value." + }, + { + "value": "soundex", + "name": "Soundex", + "description": "Encodes a token into a Soundex value." + }, + { + "value": "refinedSoundex", + "name": "RefinedSoundex", + "description": "Encodes a token into a Refined Soundex value." + }, + { + "value": "caverphone1", + "name": "Caverphone1", + "description": "Encodes a token into a Caverphone 1.0 value." + }, + { + "value": "caverphone2", + "name": "Caverphone2", + "description": "Encodes a token into a Caverphone 2.0 value." + }, + { + "value": "cologne", + "name": "Cologne", + "description": "Encodes a token into a Cologne Phonetic value." + }, + { + "value": "nysiis", + "name": "Nysiis", + "description": "Encodes a token into a NYSIIS value." + }, + { + "value": "koelnerPhonetik", + "name": "KoelnerPhonetik", + "description": "Encodes a token using the Kölner Phonetik algorithm." + }, + { + "value": "haasePhonetik", + "name": "HaasePhonetik", + "description": "Encodes a token using the Haase refinement of the Kölner Phonetik algorithm." + }, + { + "value": "beiderMorse", + "name": "BeiderMorse", + "description": "Encodes a token into a Beider-Morse value." + } + ] + }, + "description": "Identifies the type of phonetic encoder to use with a PhoneticTokenFilter." + }, + "PhoneticTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PhoneticTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "encoder": { + "$ref": "#/definitions/PhoneticEncoder", + "default": "metaphone", + "description": "The phonetic encoder to use. Default is \"metaphone\"." + }, + "replace": { + "x-ms-client-name": "ReplaceOriginalTokens", + "type": "boolean", + "default": true, + "description": "A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true." + } + }, + "description": "Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + } + }, + "ShingleTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ShingleTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The maximum shingle size. Default and minimum value is 2." + }, + "minShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize." + }, + "outputUnigrams": { + "type": "boolean", + "default": true, + "description": "A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true." + }, + "outputUnigramsIfNoShingles": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false." + }, + "tokenSeparator": { + "type": "string", + "default": " ", + "description": "The string to use when joining adjacent tokens to form a shingle. Default is a single space (\" \")." + }, + "filterToken": { + "type": "string", + "default": "_", + "description": "The string to insert for each position at which there is no token. Default is an underscore (\"_\")." + } + }, + "description": "Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + } + }, + "SnowballTokenFilterLanguage": { + "type": "string", + "enum": [ + "armenian", + "basque", + "catalan", + "danish", + "dutch", + "english", + "finnish", + "french", + "german", + "german2", + "hungarian", + "italian", + "kp", + "lovins", + "norwegian", + "porter", + "portuguese", + "romanian", + "russian", + "spanish", + "swedish", + "turkish" + ], + "x-ms-enum": { + "name": "SnowballTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene Snowball stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene Snowball stemming tokenizer for Basque." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene Snowball stemming tokenizer for Catalan." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene Snowball stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene Snowball stemming tokenizer for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene Snowball stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene Snowball stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene Snowball stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene Snowball stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene Snowball stemming tokenizer for Hungarian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene Snowball stemming tokenizer for Italian." + }, + { + "value": "kp", + "name": "Kp", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene Snowball stemming tokenizer for Norwegian." + }, + { + "value": "porter", + "name": "Porter", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Porter stemming algorithm." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene Snowball stemming tokenizer for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene Snowball stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene Snowball stemming tokenizer for Russian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene Snowball stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene Snowball stemming tokenizer for Swedish." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene Snowball stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a Snowball token filter." + }, + "SnowballTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SnowballTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/SnowballTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + } + }, + "StemmerTokenFilterLanguage": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "dutchKp", + "english", + "lightEnglish", + "minimalEnglish", + "possessiveEnglish", + "porter2", + "lovins", + "finnish", + "lightFinnish", + "french", + "lightFrench", + "minimalFrench", + "galician", + "minimalGalician", + "german", + "german2", + "lightGerman", + "minimalGerman", + "greek", + "hindi", + "hungarian", + "lightHungarian", + "indonesian", + "irish", + "italian", + "lightItalian", + "sorani", + "latvian", + "norwegian", + "lightNorwegian", + "minimalNorwegian", + "lightNynorsk", + "minimalNynorsk", + "portuguese", + "lightPortuguese", + "minimalPortuguese", + "portugueseRslp", + "romanian", + "russian", + "lightRussian", + "spanish", + "lightSpanish", + "swedish", + "lightSwedish", + "turkish" + ], + "x-ms-enum": { + "name": "StemmerTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Lucene stemming tokenizer for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene stemming tokenizer for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the Lucene stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Lucene stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene stemming tokenizer for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Lucene stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene stemming tokenizer for Dutch." + }, + { + "value": "dutchKp", + "name": "DutchKp", + "description": "Selects the Lucene stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene stemming tokenizer for English." + }, + { + "value": "lightEnglish", + "name": "LightEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does light stemming." + }, + { + "value": "minimalEnglish", + "name": "MinimalEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does minimal stemming." + }, + { + "value": "possessiveEnglish", + "name": "PossessiveEnglish", + "description": "Selects the Lucene stemming tokenizer for English that removes trailing possessives from words." + }, + { + "value": "porter2", + "name": "Porter2", + "description": "Selects the Lucene stemming tokenizer for English that uses the Porter2 stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene stemming tokenizer for Finnish." + }, + { + "value": "lightFinnish", + "name": "LightFinnish", + "description": "Selects the Lucene stemming tokenizer for Finnish that does light stemming." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene stemming tokenizer for French." + }, + { + "value": "lightFrench", + "name": "LightFrench", + "description": "Selects the Lucene stemming tokenizer for French that does light stemming." + }, + { + "value": "minimalFrench", + "name": "MinimalFrench", + "description": "Selects the Lucene stemming tokenizer for French that does minimal stemming." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the Lucene stemming tokenizer for Galician." + }, + { + "value": "minimalGalician", + "name": "MinimalGalician", + "description": "Selects the Lucene stemming tokenizer for Galician that does minimal stemming." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "lightGerman", + "name": "LightGerman", + "description": "Selects the Lucene stemming tokenizer for German that does light stemming." + }, + { + "value": "minimalGerman", + "name": "MinimalGerman", + "description": "Selects the Lucene stemming tokenizer for German that does minimal stemming." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Lucene stemming tokenizer for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Lucene stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian." + }, + { + "value": "lightHungarian", + "name": "LightHungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian that does light stemming." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Lucene stemming tokenizer for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the Lucene stemming tokenizer for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene stemming tokenizer for Italian." + }, + { + "value": "lightItalian", + "name": "LightItalian", + "description": "Selects the Lucene stemming tokenizer for Italian that does light stemming." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the Lucene stemming tokenizer for Sorani." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Lucene stemming tokenizer for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "lightNorwegian", + "name": "LightNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does light stemming." + }, + { + "value": "minimalNorwegian", + "name": "MinimalNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does minimal stemming." + }, + { + "value": "lightNynorsk", + "name": "LightNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does light stemming." + }, + { + "value": "minimalNynorsk", + "name": "MinimalNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does minimal stemming." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese." + }, + { + "value": "lightPortuguese", + "name": "LightPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does light stemming." + }, + { + "value": "minimalPortuguese", + "name": "MinimalPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does minimal stemming." + }, + { + "value": "portugueseRslp", + "name": "PortugueseRslp", + "description": "Selects the Lucene stemming tokenizer for Portuguese that uses the RSLP stemming algorithm." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene stemming tokenizer for Russian." + }, + { + "value": "lightRussian", + "name": "LightRussian", + "description": "Selects the Lucene stemming tokenizer for Russian that does light stemming." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene stemming tokenizer for Spanish." + }, + { + "value": "lightSpanish", + "name": "LightSpanish", + "description": "Selects the Lucene stemming tokenizer for Spanish that does light stemming." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene stemming tokenizer for Swedish." + }, + { + "value": "lightSwedish", + "name": "LightSwedish", + "description": "Selects the Lucene stemming tokenizer for Swedish that does light stemming." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a stemmer token filter." + }, + "StemmerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/StemmerTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "Language specific stemming filter. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + } + }, + "StemmerOverrideTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerOverrideTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stemming rules in the following format: \"word => stem\", for example: \"ran => run\"." + } + }, + "required": [ + "rules" + ], + "description": "Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html" + } + }, + "StopwordsList": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "english", + "finnish", + "french", + "galician", + "german", + "greek", + "hindi", + "hungarian", + "indonesian", + "irish", + "italian", + "latvian", + "norwegian", + "persian", + "portuguese", + "romanian", + "russian", + "sorani", + "spanish", + "swedish", + "thai", + "turkish" + ], + "x-ms-enum": { + "name": "StopwordsList", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the stopword list for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the stopword list for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the stopword list for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the stopword list for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the stopword list for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the stopword list for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the stopword list for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the stopword list for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the stopword list for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the stopword list for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the stopword list for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the stopword list for French." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the stopword list for Galician." + }, + { + "value": "german", + "name": "German", + "description": "Selects the stopword list for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the stopword list for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the stopword list for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the stopword list for Hungarian." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the stopword list for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the stopword list for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the stopword list for Italian." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the stopword list for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the stopword list for Norwegian." + }, + { + "value": "persian", + "name": "Persian", + "description": "Selects the stopword list for Persian." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the stopword list for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the stopword list for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the stopword list for Russian." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the stopword list for Sorani." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the stopword list for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the stopword list for Swedish." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the stopword list for Thai." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the stopword list for Turkish." + } + ] + }, + "description": "Identifies a predefined list of language-specific stopwords." + }, + "StopwordsTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopwordsTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of stopwords. This property and the stopwords list property cannot both be set." + }, + "stopwordsList": { + "$ref": "#/definitions/StopwordsList", + "default": "english", + "description": "A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + }, + "removeTrailing": { + "x-ms-client-name": "RemoveTrailingStopWords", + "type": "boolean", + "default": true, + "description": "A value indicating whether to ignore the last search term if it's a stop word. Default is true." + } + }, + "description": "Removes stop words from a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + } + }, + "SynonymTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SynonymTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to case-fold input for matching. Default is false." + }, + "expand": { + "type": "boolean", + "default": true, + "description": "A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true." + } + }, + "required": [ + "synonyms" + ], + "description": "Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html" + } + }, + "TruncateTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.TruncateTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "length": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The length at which terms will be truncated. Default and maximum is 300." + } + }, + "description": "Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + } + }, + "UniqueTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UniqueTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "onlyOnSamePosition": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to remove duplicates only at the same position. Default is false." + } + }, + "description": "Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + } + }, + "WordDelimiterTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.WordDelimiterTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "generateWordParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate part words. If set, causes parts of words to be generated; for example \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "generateNumberParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate number subwords. Default is true." + }, + "catenateWords": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, \"Azure-Search\" becomes \"AzureSearch\". Default is false." + }, + "catenateNumbers": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, \"1-2\" becomes \"12\". Default is false." + }, + "catenateAll": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all subword parts will be catenated. For example, if this is set to true, \"Azure-Search-1\" becomes \"AzureSearch1\". Default is false." + }, + "splitOnCaseChange": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split words on caseChange. For example, if this is set to true, \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether original words will be preserved and added to the subword list. Default is false." + }, + "splitOnNumerics": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split on numbers. For example, if this is set to true, \"Azure1Search\" becomes \"Azure\" \"1\" \"Search\". Default is true." + }, + "stemEnglishPossessive": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to remove trailing \"'s\" for each subword. Default is true." + }, + "protectedWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of tokens to protect from being delimited." + } + }, + "description": "Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html" + } + }, + "CharFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the char filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for character filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "MappingCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MappingCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "mappings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of mappings of the following format: \"a=>b\" (all occurrences of the character \"a\" will be replaced with character \"b\")." + } + }, + "required": [ + "mappings" + ], + "description": "A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/MappingCharFilter.html" + } + }, + "PatternReplaceCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html" + } + }, + "Similarity": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "ClassicSimilarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicSimilarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "description": "Legacy similarity algorithm which uses the Lucene TFIDFSimilarity implementation of TF-IDF. This variation of TF-IDF introduces static document length normalization as well as coordinating factors that penalize documents that only partially match the searched queries." + }, + "BM25Similarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.BM25Similarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "properties": { + "k1": { + "type": "number", + "format": "double", + "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency.", + "x-nullable": true + }, + "b": { + "type": "number", + "format": "double", + "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document.", + "x-nullable": true + } + }, + "description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)." + }, + "SemanticSettings": { + "properties": { + "defaultConfiguration": { + "type": "string", + "description": "Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time." + }, + "configurations": { + "type": "array", + "items": { + "$ref": "#/definitions/SemanticConfiguration" + }, + "description": "The semantic configurations for the index." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Defines parameters for a search index that influence semantic capabilities." + }, + "SemanticConfiguration": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the semantic configuration.", + "x-nullable": false + }, + "prioritizedFields": { + "$ref": "#/definitions/PrioritizedFields", + "x-nullable": false, + "description": "Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set." + } + }, + "required": [ + "name", + "prioritizedFields" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Defines a specific configuration to be used in the context of semantic capabilities." + }, + "PrioritizedFields": { + "properties": { + "titleField": { + "$ref": "#/definitions/SemanticField", + "description": "Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank." + }, + "prioritizedContentFields": { + "type": "array", + "items": { + "$ref": "#/definitions/SemanticField" + }, + "description": "Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long." + }, + "prioritizedKeywordsFields": { + "type": "array", + "items": { + "$ref": "#/definitions/SemanticField" + }, + "description": "Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/semantic-search-overview" + }, + "description": "Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers." + }, + "SemanticField": { + "properties": { + "fieldName": { + "type": "string", + "description": "", + "x-nullable": false + } + }, + "description": "A field that is used as part of the semantic configuration." + }, + "VectorSearch": { + "type": "object", + "properties": { + "algorithmConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VectorSearchAlgorithmConfiguration" + }, + "description": "Contains configuration options specific to the algorithm used during indexing time." + } + }, + "description": "Contains configuration options related to vector search." + }, + "VectorSearchAlgorithmConfiguration": { + "type": "object", + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name to associate with this particular configuration.", + "x-nullable": false + }, + "kind": { + "type": "string", + "description": "The name of the kind of algorithm being configured for use with vector search. Only `hnsw` is supported in the current preview.", + "x-nullable": false + }, + "hnswParameters": { + "$ref": "#/definitions/HnswParameters", + "description": "Contains the parameters specific to hnsw algorithm." + } + }, + "required": [ + "name", + "kind" + ], + "description": "Contains configuration options specific to the algorithm used during indexing time." + }, + "HnswParameters": { + "type": "object", + "properties": { + "m": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 4, + "maximum": 10, + "default": 4, + "description": "The number of bi-directional links created for every new element during construction. Increasing this parameter value may improve recall and reduce retrieval times for datasets with high intrinsic dimensionality at the expense of increased memory consumption and longer indexing time." + }, + "efConstruction": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 100, + "maximum": 1000, + "default": 400, + "description": "The size of the dynamic list containing the nearest neighbors, which is used during index time. Increasing this parameter may improve index quality, at the expense of increased indexing time. At a certain point, increasing this parameter leads to diminishing returns." + }, + "efSearch": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 100, + "maximum": 1000, + "default": 500, + "description": "The size of the dynamic list containing the nearest neighbors, which is used during search time. Increasing this parameter may improve search results, at the expense of slower search. Increasing this parameter leads to diminishing returns.." + }, + "metric": { + "$ref": "#/definitions/VectorSearchAlgorithmMetric", + "x-nullable": true, + "description": "The similarity metric to use for vector comparisons." + } + }, + "description": "Contains the parameters specific to hnsw algorithm." + }, + "VectorSearchAlgorithmMetric": { + "type": "string", + "enum": [ + "cosine", + "euclidean", + "dotProduct" + ], + "x-ms-enum": { + "name": "VectorSearchAlgorithmMetric", + "modelAsString": true, + "values": [ + { + "value": "cosine", + "name": "Cosine" + }, + { + "value": "euclidean", + "name": "Euclidean" + }, + { + "value": "dotProduct", + "name": "DotProduct" + } + ] + }, + "description": "The similarity metric to use for vector comparisons." + }, + "DataSourceCredentials": { + "properties": { + "connectionString": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "type": "string", + "description": "The connection string for the datasource. Set to '' if you do not want the connection string updated." + } + }, + "description": "Represents credentials that can be used to connect to a datasource." + }, + "SearchIndexerDataContainer": { + "properties": { + "name": { + "type": "string", + "description": "The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed." + }, + "query": { + "type": "string", + "description": "A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources." + } + }, + "required": [ + "name" + ], + "description": "Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed." + }, + "SearchIndexerDataIdentity": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the identity." + } + }, + "required": [ + "@odata.type" + ], + "description": "Abstract base type for data identities." + }, + "SearchIndexerDataNoneIdentity": { + "description": "Clears the identity property of a datasource.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DataNoneIdentity", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerDataIdentity" + } + ] + }, + "SearchIndexerDataUserAssignedIdentity": { + "description": "Specifies the identity for a datasource to use.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DataUserAssignedIdentity", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerDataIdentity" + } + ], + "properties": { + "userAssignedIdentity": { + "type": "string", + "description": "The fully qualified Azure resource Id of a user assigned managed identity typically in the form \"/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId\" that should have been assigned to the search service." + } + }, + "required": [ + "userAssignedIdentity" + ] + }, + "DataChangeDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the data change detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data change detection policies." + }, + "HighWaterMarkChangeDetectionPolicy": { + "description": "Defines a data change detection policy that captures changes based on the value of a high water mark column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ], + "properties": { + "highWaterMarkColumnName": { + "type": "string", + "description": "The name of the high water mark column." + } + }, + "required": [ + "highWaterMarkColumnName" + ] + }, + "SqlIntegratedChangeTrackingPolicy": { + "description": "Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ] + }, + "DataDeletionDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the data deletion detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data deletion detection policies." + }, + "SoftDeleteColumnDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ], + "properties": { + "softDeleteColumnName": { + "type": "string", + "description": "The name of the column to use for soft-deletion detection." + }, + "softDeleteMarkerValue": { + "type": "string", + "description": "The marker value that identifies an item as deleted." + } + } + }, + "SearchIndexerDataSourceType": { + "type": "string", + "enum": [ + "azuresql", + "cosmosdb", + "azureblob", + "azuretable", + "mysql", + "adlsgen2" + ], + "x-ms-enum": { + "name": "SearchIndexerDataSourceType", + "modelAsString": true, + "values": [ + { + "value": "azuresql", + "name": "AzureSql", + "description": "Indicates an Azure SQL datasource." + }, + { + "value": "cosmosdb", + "name": "CosmosDb", + "description": "Indicates a CosmosDB datasource." + }, + { + "value": "azureblob", + "name": "AzureBlob", + "description": "Indicates an Azure Blob datasource." + }, + { + "value": "azuretable", + "name": "AzureTable", + "description": "Indicates an Azure Table datasource." + }, + { + "value": "mysql", + "name": "MySql", + "description": "Indicates a MySql datasource." + }, + { + "value": "adlsgen2", + "name": "AdlsGen2", + "description": "Indicates an ADLS Gen2 datasource." + } + ] + }, + "description": "Defines the type of a datasource." + }, + "SearchIndexerDataSource": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the datasource." + }, + "description": { + "type": "string", + "description": "The description of the datasource." + }, + "type": { + "$ref": "#/definitions/SearchIndexerDataSourceType", + "description": "The type of the datasource." + }, + "credentials": { + "$ref": "#/definitions/DataSourceCredentials", + "description": "Credentials for the datasource." + }, + "container": { + "$ref": "#/definitions/SearchIndexerDataContainer", + "description": "The data container for the datasource." + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If \"none\" is specified, the value of this property is cleared." + }, + "dataChangeDetectionPolicy": { + "$ref": "#/definitions/DataChangeDetectionPolicy", + "x-nullable": true, + "description": "The data change detection policy for the datasource." + }, + "dataDeletionDetectionPolicy": { + "$ref": "#/definitions/DataDeletionDetectionPolicy", + "x-nullable": true, + "description": "The data deletion detection policy for the datasource." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the data source." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition in Azure Cognitive Search. Once you have encrypted your data source definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + } + }, + "required": [ + "name", + "type", + "credentials", + "container" + ], + "description": "Represents a datasource definition, which can be used to configure an indexer." + }, + "ListDataSourcesResult": { + "properties": { + "value": { + "x-ms-client-name": "DataSources", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The datasources in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Datasources request. If successful, it includes the full definitions of all datasources." + }, + "IndexingSchedule": { + "properties": { + "interval": { + "type": "string", + "format": "duration", + "description": "The interval of time between indexer executions." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time when an indexer should start running." + } + }, + "required": [ + "interval" + ], + "description": "Represents a schedule for indexer execution." + }, + "IndexingParameters": { + "properties": { + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type." + }, + "maxFailedItems": { + "type": "integer", + "format": "int32", + "default": 0, + "x-nullable": true, + "description": "The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0." + }, + "maxFailedItemsPerBatch": { + "type": "integer", + "format": "int32", + "default": 0, + "x-nullable": true, + "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0." + }, + "configuration": { + "$ref": "#/definitions/IndexingParametersConfiguration" + } + }, + "description": "Represents parameters for indexer execution.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "IndexingParametersConfiguration": { + "type": "object", + "properties": { + "parsingMode": { + "$ref": "#/definitions/ParsingMode" + }, + "excludedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude \".png, .mp4\" to skip over those files during indexing." + }, + "indexedFileNameExtensions": { + "type": "string", + "default": "", + "description": "Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files \".docx, .pptx, .msg\" to specifically include those file types." + }, + "failOnUnsupportedContentType": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance." + }, + "failOnUnprocessableDocument": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set to false if you want to continue indexing if a document fails indexing." + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "type": "boolean", + "default": false, + "description": "For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://docs.microsoft.com/azure/search/search-limits-quotas-capacity." + }, + "delimitedTextHeaders": { + "type": "string", + "description": "For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index." + }, + "delimitedTextDelimiter": { + "type": "string", + "description": "For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, \"|\")." + }, + "firstLineContainsHeaders": { + "type": "boolean", + "default": true, + "description": "For CSV blobs, indicates that the first (non-blank) line of each blob contains headers." + }, + "documentRoot": { + "type": "string", + "description": "For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property." + }, + "dataToExtract": { + "$ref": "#/definitions/DataToExtract" + }, + "imageAction": { + "$ref": "#/definitions/ImageAction" + }, + "allowSkillsetToReadFileData": { + "type": "boolean", + "default": false, + "description": "If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill." + }, + "pdfTextRotationAlgorithm": { + "$ref": "#/definitions/PdfTextRotationAlgorithm" + }, + "executionEnvironment": { + "$ref": "#/definitions/ExecutionEnvironment" + }, + "queryTimeout": { + "type": "string", + "default": "00:05:00", + "description": "Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format \"hh:mm:ss\"." + } + }, + "additionalProperties": true, + "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-indexer#parameters" + } + }, + "ParsingMode": { + "type": "string", + "enum": [ + "default", + "text", + "delimitedText", + "json", + "jsonArray", + "jsonLines" + ], + "x-ms-enum": { + "name": "BlobIndexerParsingMode", + "modelAsString": true, + "values": [ + { + "value": "default", + "name": "Default", + "description": "Set to default for normal file processing." + }, + { + "value": "text", + "name": "Text", + "description": "Set to text to improve indexing performance on plain text files in blob storage." + }, + { + "value": "delimitedText", + "name": "DelimitedText", + "description": "Set to delimitedText when blobs are plain CSV files." + }, + { + "value": "json", + "name": "Json", + "description": "Set to json to extract structured content from JSON files." + }, + { + "value": "jsonArray", + "name": "JsonArray", + "description": "Set to jsonArray to extract individual elements of a JSON array as separate documents in Azure Cognitive Search." + }, + { + "value": "jsonLines", + "name": "JsonLines", + "description": "Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents in Azure Cognitive Search." + } + ] + }, + "default": "default", + "description": "Represents the parsing mode for indexing from an Azure blob data source." + }, + "DataToExtract": { + "type": "string", + "enum": [ + "storageMetadata", + "allMetadata", + "contentAndMetadata" + ], + "x-ms-enum": { + "name": "BlobIndexerDataToExtract", + "modelAsString": true, + "values": [ + { + "value": "storageMetadata", + "name": "StorageMetadata", + "description": "Indexes just the standard blob properties and user-specified metadata." + }, + { + "value": "allMetadata", + "name": "AllMetadata", + "description": "Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed)." + }, + { + "value": "contentAndMetadata", + "name": "ContentAndMetadata", + "description": "Extracts all metadata and textual content from each blob." + } + ] + }, + "default": "contentAndMetadata", + "description": "Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when \"imageAction\" is set to a value other than \"none\". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs." + }, + "ImageAction": { + "type": "string", + "enum": [ + "none", + "generateNormalizedImages", + "generateNormalizedImagePerPage" + ], + "x-ms-enum": { + "name": "BlobIndexerImageAction", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Ignores embedded images or image files in the data set. This is the default." + }, + { + "value": "generateNormalizedImages", + "name": "GenerateNormalizedImages", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field. This action requires that \"dataToExtract\" is set to \"contentAndMetadata\". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option." + }, + { + "value": "generateNormalizedImagePerPage", + "name": "GenerateNormalizedImagePerPage", + "description": "Extracts text from images (for example, the word \"STOP\" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if \"generateNormalizedImages\" was set." + } + ] + }, + "default": "none", + "description": "Determines how to process embedded images and image files in Azure blob storage. Setting the \"imageAction\" configuration to any value other than \"none\" requires that a skillset also be attached to that indexer." + }, + "PdfTextRotationAlgorithm": { + "type": "string", + "enum": [ + "none", + "detectAngles" + ], + "x-ms-enum": { + "name": "BlobIndexerPDFTextRotationAlgorithm", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "Leverages normal text extraction. This is the default." + }, + { + "value": "detectAngles", + "name": "DetectAngles", + "description": "May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply." + } + ] + }, + "default": "none", + "description": "Determines algorithm for text extraction from PDF files in Azure blob storage." + }, + "ExecutionEnvironment": { + "type": "string", + "enum": [ + "standard", + "private" + ], + "x-ms-enum": { + "name": "IndexerExecutionEnvironment", + "modelAsString": true, + "values": [ + { + "value": "standard", + "name": "standard", + "description": "Indicates that Azure Cognitive Search can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value." + }, + { + "value": "private", + "name": "private", + "description": "Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources." + } + ] + }, + "default": "standard", + "description": "Specifies the environment in which the indexer should execute." + }, + "FieldMappingFunction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field mapping function." + }, + "parameters": { + "type": "object", + "x-nullable": true, + "additionalProperties": true, + "description": "A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type." + } + }, + "required": [ + "name" + ], + "description": "Represents a function that transforms a value from a data source before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "FieldMapping": { + "properties": { + "sourceFieldName": { + "type": "string", + "description": "The name of the field in the data source." + }, + "targetFieldName": { + "type": "string", + "description": "The name of the target field in the index. Same as the source field name by default." + }, + "mappingFunction": { + "$ref": "#/definitions/FieldMappingFunction", + "x-nullable": true, + "description": "A function to apply to each source field value before indexing." + } + }, + "required": [ + "sourceFieldName" + ], + "description": "Defines a mapping between a field in a data source and a target field in an index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "SearchIndexer": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the indexer." + }, + "description": { + "type": "string", + "description": "The description of the indexer." + }, + "dataSourceName": { + "type": "string", + "description": "The name of the datasource from which this indexer reads data." + }, + "skillsetName": { + "type": "string", + "description": "The name of the skillset executing with this indexer." + }, + "targetIndexName": { + "type": "string", + "description": "The name of the index to which this indexer writes data." + }, + "schedule": { + "$ref": "#/definitions/IndexingSchedule", + "x-nullable": true, + "description": "The schedule for this indexer." + }, + "parameters": { + "$ref": "#/definitions/IndexingParameters", + "x-nullable": true, + "description": "Parameters for indexer execution." + }, + "fieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Defines mappings between fields in the data source and corresponding target fields in the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "outputFieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Output field mappings are applied after enrichment and immediately before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "disabled": { + "x-ms-client-name": "IsDisabled", + "type": "boolean", + "default": false, + "x-nullable": true, + "description": "A value indicating whether the indexer is disabled. Default is false." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the indexer." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them in Azure Cognitive Search. Once you have encrypted your indexer definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "cache": { + "$ref": "#/definitions/SearchIndexerCache", + "x-nullable": true, + "description": "Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-howto-incremental-index" + } + } + }, + "required": [ + "name", + "dataSourceName", + "targetIndexName" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Indexer-operations" + }, + "description": "Represents an indexer." + }, + "ListIndexersResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexers", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The indexers in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexers request. If successful, it includes the full definitions of all indexers." + }, + "SearchIndexerError": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item for which indexing failed." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The message describing the error that occurred while processing the item." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the error to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of errors. This may not be always available." + } + }, + "required": [ + "errorMessage", + "statusCode" + ], + "description": "Represents an item- or document-level indexing error." + }, + "SearchIndexerWarning": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item which generated a warning." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The message describing the warning that occurred while processing the item." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of warnings. This may not be always available." + } + }, + "required": [ + "message" + ], + "description": "Represents an item-level warning." + }, + "IndexerExecutionResult": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerExecutionStatus", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "statusDetail": { + "$ref": "#/definitions/IndexerExecutionStatusDetail", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "currentState": { + "$ref": "#/definitions/IndexerCurrentState", + "readOnly": true, + "description": "All of the state that defines and dictates the indexer's current execution." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message indicating the top-level error, if any." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The start time of this indexer execution." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "x-nullable": true, + "description": "The end time of this indexer execution, if the execution has already completed." + }, + "errors": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerError" + }, + "description": "The item-level indexing errors." + }, + "warnings": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerWarning" + }, + "description": "The item-level indexing warnings." + }, + "itemsProcessed": { + "x-ms-client-name": "ItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed." + }, + "itemsFailed": { + "x-ms-client-name": "FailedItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that failed to be indexed during this indexer execution." + }, + "initialTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution started." + }, + "finalTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution finished." + } + }, + "required": [ + "status", + "errors", + "warnings", + "itemsProcessed", + "itemsFailed" + ], + "description": "Represents the result of an individual indexer execution." + }, + "IndexerExecutionStatus": { + "type": "string", + "enum": [ + "transientFailure", + "success", + "inProgress", + "reset" + ], + "x-ms-enum": { + "name": "IndexerExecutionStatus", + "modelAsString": false, + "values": [ + { + "value": "transientFailure", + "name": "TransientFailure", + "description": "An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule." + }, + { + "value": "success", + "name": "Success", + "description": "Indexer execution completed successfully." + }, + { + "value": "inProgress", + "name": "InProgress", + "description": "Indexer execution is in progress." + }, + { + "value": "reset", + "name": "Reset", + "description": "Indexer has been reset." + } + ] + }, + "x-nullable": false, + "description": "Represents the status of an individual indexer execution." + }, + "SearchIndexerStatus": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerStatus", + "readOnly": true, + "description": "Overall indexer status." + }, + "lastResult": { + "$ref": "#/definitions/IndexerExecutionResult", + "readOnly": true, + "description": "The result of the most recent or an in-progress indexer execution." + }, + "executionHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexerExecutionResult" + }, + "description": "History of the recent indexer executions, sorted in reverse chronological order." + }, + "limits": { + "$ref": "#/definitions/SearchIndexerLimits", + "readOnly": true, + "description": "The execution limits for the indexer." + } + }, + "required": [ + "status", + "executionHistory", + "limits" + ], + "description": "Represents the current status and execution history of an indexer." + }, + "IndexerStatus": { + "type": "string", + "enum": [ + "unknown", + "error", + "running" + ], + "x-ms-enum": { + "name": "IndexerStatus", + "modelAsString": false, + "values": [ + { + "value": "unknown", + "name": "Unknown", + "description": "Indicates that the indexer is in an unknown state." + }, + { + "value": "error", + "name": "Error", + "description": "Indicates that the indexer experienced an error that cannot be corrected without human intervention." + }, + { + "value": "running", + "name": "Running", + "description": "Indicates that the indexer is running normally." + } + ] + }, + "x-nullable": false, + "description": "Represents the overall indexer status." + }, + "IndexerExecutionStatusDetail": { + "type": "string", + "enum": [ + "resetDocs" + ], + "x-ms-enum": { + "name": "IndexerExecutionStatusDetail", + "modelAsString": true, + "values": [ + { + "value": "resetDocs", + "name": "ResetDocs", + "description": "Indicates that the reset that occurred was for a call to ResetDocs." + } + ] + }, + "description": "Details the status of an individual indexer execution." + }, + "IndexerCurrentState": { + "properties": { + "mode": { + "$ref": "#/definitions/IndexingMode", + "readOnly": true, + "description": "The mode the indexer is running in." + }, + "allDocsInitialChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state used when indexing starts on all documents in the datasource." + }, + "allDocsFinalChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state value when indexing finishes on all documents in the datasource." + }, + "resetDocsInitialChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state used when indexing starts on select, reset documents in the datasource." + }, + "resetDocsFinalChangeTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state value when indexing finishes on select, reset documents in the datasource." + }, + "resetDocumentKeys": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys." + }, + "resetDatasourceDocumentIds": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids." + } + }, + "description": "Represents all of the state that defines and dictates the indexer's current execution." + }, + "IndexingMode": { + "type": "string", + "enum": [ + "indexingAllDocs", + "indexingResetDocs" + ], + "x-ms-enum": { + "name": "IndexingMode", + "modelAsString": true, + "values": [ + { + "value": "indexingAllDocs", + "name": "IndexingAllDocs", + "description": "The indexer is indexing all documents in the datasource." + }, + { + "value": "indexingResetDocs", + "name": "indexingResetDocs", + "description": "The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status." + } + ] + }, + "x-nullable": false, + "description": "Represents the mode the indexer is executing in." + }, + "SearchIndexerLimits": { + "properties": { + "maxRunTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "The maximum duration that the indexer is permitted to run for one execution." + }, + "maxDocumentExtractionSize": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum size of a document, in bytes, which will be considered valid for indexing." + }, + "maxDocumentContentCharactersToExtract": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum number of characters that will be extracted from a document picked up for indexing." + } + } + }, + "SearchField": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field, which must be unique within the fields collection of the index or parent field.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + } + }, + "type": { + "$ref": "#/definitions/SearchFieldDataType", + "description": "The data type of the field.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/supported-data-types" + } + }, + "key": { + "type": "boolean", + "description": "A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields." + }, + "retrievable": { + "type": "boolean", + "description": "A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields and null for complex fields." + }, + "searchable": { + "type": "boolean", + "description": "A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like \"sunny day\", internally it will be split into the individual tokens \"sunny\" and \"day\". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index since Azure Cognitive Search will store an additional tokenized version of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false." + }, + "filterable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to \"sunny day\", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields." + }, + "sortable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $orderby expressions. By default Azure Cognitive Search sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields." + }, + "facetable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields." + }, + "analyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "searchAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields.", + "x-nullable": true + }, + "indexAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "normalizer": { + "externalDocs": { + "url": "https://aka.ms/azs-normalizers" + }, + "$ref": "#/definitions/LexicalNormalizerName", + "description": "The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields.", + "x-nullable": true + }, + "dimensions": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "minimum": 2, + "maximum": 2048, + "description": "The dimensionality of the vector field." + }, + "vectorSearchConfiguration": { + "type": "string", + "x-nullable": false, + "description": "The name of the vector search algorithm configuration that specifies the algorithm and optional parameters for searching the vector field." + }, + "synonymMaps": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Synonym-Map-operations" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields." + } + }, + "required": [ + "name", + "type" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Represents a field in an index definition, which describes the name, data type, and search behavior of a field." + }, + "TextWeights": { + "properties": { + "weights": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double", + "x-nullable": false + }, + "description": "The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field." + } + }, + "required": [ + "weights" + ], + "description": "Defines weights on index fields for which matches should boost scoring in search queries." + }, + "ScoringFunction": { + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case." + }, + "fieldName": { + "type": "string", + "description": "The name of the field used as input to the scoring function." + }, + "boost": { + "type": "number", + "format": "double", + "description": "A multiplier for the raw score. Must be a positive number not equal to 1.0." + }, + "interpolation": { + "$ref": "#/definitions/ScoringFunctionInterpolation", + "description": "A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"." + } + }, + "required": [ + "type", + "fieldName", + "boost" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Base type for functions that can modify document scores during ranking." + }, + "DistanceScoringFunction": { + "x-ms-discriminator-value": "distance", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "distance": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/DistanceScoringParameters", + "description": "Parameter values for the distance scoring function." + } + }, + "required": [ + "distance" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on distance from a geographic location." + }, + "DistanceScoringParameters": { + "properties": { + "referencePointParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the reference location." + }, + "boostingDistance": { + "type": "number", + "format": "double", + "description": "The distance in kilometers from the reference location where the boosting range ends." + } + }, + "required": [ + "referencePointParameter", + "boostingDistance" + ], + "description": "Provides parameter values to a distance scoring function." + }, + "FreshnessScoringFunction": { + "x-ms-discriminator-value": "freshness", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "freshness": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/FreshnessScoringParameters", + "description": "Parameter values for the freshness scoring function." + } + }, + "required": [ + "freshness" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the value of a date-time field." + }, + "FreshnessScoringParameters": { + "properties": { + "boostingDuration": { + "type": "string", + "format": "duration", + "description": "The expiration period after which boosting will stop for a particular document." + } + }, + "required": [ + "boostingDuration" + ], + "description": "Provides parameter values to a freshness scoring function." + }, + "MagnitudeScoringFunction": { + "x-ms-discriminator-value": "magnitude", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "magnitude": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/MagnitudeScoringParameters", + "description": "Parameter values for the magnitude scoring function." + } + }, + "required": [ + "magnitude" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the magnitude of a numeric field." + }, + "MagnitudeScoringParameters": { + "properties": { + "boostingRangeStart": { + "type": "number", + "format": "double", + "description": "The field value at which boosting starts." + }, + "boostingRangeEnd": { + "type": "number", + "format": "double", + "description": "The field value at which boosting ends." + }, + "constantBoostBeyondRange": { + "x-ms-client-name": "ShouldBoostBeyondRangeByConstant", + "type": "boolean", + "description": "A value indicating whether to apply a constant boost for field values beyond the range end value; default is false." + } + }, + "required": [ + "boostingRangeStart", + "boostingRangeEnd" + ], + "description": "Provides parameter values to a magnitude scoring function." + }, + "TagScoringFunction": { + "x-ms-discriminator-value": "tag", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "tag": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/TagScoringParameters", + "description": "Parameter values for the tag scoring function." + } + }, + "required": [ + "tag" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores of documents with string values matching a given list of tags." + }, + "TagScoringParameters": { + "properties": { + "tagsParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the list of tags to compare against the target field." + } + }, + "required": [ + "tagsParameter" + ], + "description": "Provides parameter values to a tag scoring function." + }, + "ScoringFunctionInterpolation": { + "type": "string", + "enum": [ + "linear", + "constant", + "quadratic", + "logarithmic" + ], + "x-ms-enum": { + "name": "ScoringFunctionInterpolation", + "modelAsString": false, + "values": [ + { + "value": "linear", + "name": "Linear", + "description": "Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions." + }, + { + "value": "constant", + "name": "Constant", + "description": "Boosts scores by a constant factor." + }, + { + "value": "quadratic", + "name": "Quadratic", + "description": "Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + }, + { + "value": "logarithmic", + "name": "Logarithmic", + "description": "Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + } + ] + }, + "description": "Defines the function used to interpolate score boosting across a range of documents." + }, + "ScoringProfile": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the scoring profile." + }, + "text": { + "x-ms-client-name": "TextWeights", + "$ref": "#/definitions/TextWeights", + "description": "Parameters that boost scoring based on text matches in certain index fields.", + "x-nullable": true + }, + "functions": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringFunction" + }, + "description": "The collection of functions that influence the scoring of documents." + }, + "functionAggregation": { + "$ref": "#/definitions/ScoringFunctionAggregation", + "description": "A value indicating how the results of individual scoring functions should be combined. Defaults to \"Sum\". Ignored if there are no scoring functions." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines parameters for a search index that influence scoring in search queries." + }, + "ScoringFunctionAggregation": { + "type": "string", + "enum": [ + "sum", + "average", + "minimum", + "maximum", + "firstMatching" + ], + "x-ms-enum": { + "name": "ScoringFunctionAggregation", + "modelAsString": false, + "values": [ + { + "value": "sum", + "name": "Sum", + "description": "Boost scores by the sum of all scoring function results." + }, + { + "value": "average", + "name": "Average", + "description": "Boost scores by the average of all scoring function results." + }, + { + "value": "minimum", + "name": "Minimum", + "description": "Boost scores by the minimum of all scoring function results." + }, + { + "value": "maximum", + "name": "Maximum", + "description": "Boost scores by the maximum of all scoring function results." + }, + { + "value": "firstMatching", + "name": "FirstMatching", + "description": "Boost scores using the first applicable scoring function in the scoring profile." + } + ] + }, + "description": "Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile." + }, + "CorsOptions": { + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended)." + }, + "maxAgeInSeconds": { + "type": "integer", + "format": "int64", + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes.", + "x-nullable": true + } + }, + "required": [ + "allowedOrigins" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Defines options to control Cross-Origin Resource Sharing (CORS) for an index." + }, + "Suggester": { + "properties": { + "name": { + "type": "string", + "description": "The name of the suggester." + }, + "searchMode": { + "type": "string", + "enum": [ + "analyzingInfixMatching" + ], + "x-ms-enum": { + "name": "SuggesterSearchMode", + "modelAsString": false, + "values": [ + { + "value": "analyzingInfixMatching", + "name": "AnalyzingInfixMatching", + "description": "Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match." + } + ] + }, + "description": "A value indicating the capabilities of the suggester." + }, + "sourceFields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which the suggester applies. Each field must be searchable." + } + }, + "required": [ + "name", + "searchMode", + "sourceFields" + ], + "description": "Defines how the Suggest API should apply to a group of fields in the index." + }, + "SearchIndex": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the index." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "The fields of the index." + }, + "scoringProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringProfile" + }, + "description": "The scoring profiles for the index." + }, + "defaultScoringProfile": { + "type": "string", + "description": "The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used." + }, + "corsOptions": { + "$ref": "#/definitions/CorsOptions", + "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index.", + "x-nullable": true + }, + "suggesters": { + "type": "array", + "items": { + "$ref": "#/definitions/Suggester" + }, + "description": "The suggesters for the index." + }, + "analyzers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalAnalyzer" + }, + "description": "The analyzers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenizers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalTokenizer" + }, + "description": "The tokenizers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilter" + }, + "description": "The token filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilter" + }, + "description": "The character filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "normalizers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalNormalizer" + }, + "description": "The normalizers for the index.", + "externalDocs": { + "url": "https://aka.ms/azs-custom-normalizers" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "similarity": { + "$ref": "#/definitions/Similarity", + "description": "The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "semantic": { + "$ref": "#/definitions/SemanticSettings", + "description": "Defines parameters for a search index that influence semantic capabilities.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/semantic-search-overview" + }, + "x-ms-client-name": "SemanticSettings", + "x-nullable": true + }, + "vectorSearch": { + "$ref": "#/definitions/VectorSearch", + "description": "Contains configuration options related to vector search.", + "x-ms-client-name": "VectorSearch", + "x-nullable": true + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the index." + } + }, + "required": [ + "name", + "fields" + ], + "description": "Represents a search index definition, which describes the fields and search behavior of an index." + }, + "SearchAlias": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the alias." + }, + "indexes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The name of the index this alias maps to. Only one index name may be specified." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the alias." + } + }, + "required": [ + "name", + "indexes" + ], + "description": "Represents an index alias, which describes a mapping from the alias name to an index. The alias name can be used in place of the index name for supported operations." + }, + "GetIndexStatisticsResult": { + "properties": { + "documentCount": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The number of documents in the index." + }, + "storageSize": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The amount of storage in bytes consumed by the index." + } + }, + "required": [ + "documentCount", + "storageSize" + ], + "description": "Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date." + }, + "ListIndexesResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexes", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The indexes in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexes request. If successful, it includes the full definitions of all indexes." + }, + "ListAliasesResult": { + "properties": { + "value": { + "x-ms-client-name": "Aliases", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchAlias" + }, + "description": "The aliases in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Aliases request. If successful, it includes the associated index mappings for all aliases." + }, + "SearchIndexerSkillset": { + "properties": { + "name": { + "type": "string", + "description": "The name of the skillset." + }, + "description": { + "type": "string", + "description": "The description of the skillset." + }, + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerSkill" + }, + "description": "A list of skills in the skillset." + }, + "cognitiveServices": { + "x-ms-client-name": "CognitiveServicesAccount", + "$ref": "#/definitions/CognitiveServicesAccount", + "description": "Details about cognitive services to be used when running skills." + }, + "knowledgeStore": { + "$ref": "#/definitions/SearchIndexerKnowledgeStore", + "description": "Definition of additional projections to azure blob, table, or files, of enriched data." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the skillset." + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition in Azure Cognitive Search. Once you have encrypted your skillset definition, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + } + }, + "required": [ + "name", + "skills" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + }, + "description": "A list of skills." + }, + "CognitiveServicesAccount": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the cognitive service resource attached to a skillset." + }, + "description": { + "type": "string", + "description": "Description of the cognitive service resource attached to a skillset." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for describing any cognitive service resource attached to a skillset." + }, + "SearchIndexerKnowledgeStore": { + "properties": { + "storageConnectionString": { + "type": "string", + "description": "The connection string to the storage account projections will be stored in." + }, + "projections": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjection", + "x-nullable": false + }, + "description": "A list of additional projections to perform during indexing." + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + }, + "required": [ + "storageConnectionString", + "projections" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/knowledge-store-projection-overview" + }, + "description": "Definition of additional projections to azure blob, table, or files, of enriched data." + }, + "SearchIndexerKnowledgeStoreProjection": { + "properties": { + "tables": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreTableProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure Table storage." + }, + "objects": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreObjectProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure Blob storage." + }, + "files": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreFileProjectionSelector", + "x-nullable": false + }, + "description": "Projections to Azure File storage." + } + }, + "description": "Container object for various projection selectors." + }, + "SearchIndexerKnowledgeStoreProjectionSelector": { + "properties": { + "referenceKeyName": { + "type": "string", + "description": "Name of reference key to different projection." + }, + "generatedKeyName": { + "type": "string", + "description": "Name of generated key to store projection under." + }, + "source": { + "type": "string", + "description": "Source data to project." + }, + "sourceContext": { + "type": "string", + "description": "Source context for complex projections." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Nested inputs for complex projections." + } + }, + "description": "Abstract class to share properties between concrete selectors." + }, + "SearchIndexerKnowledgeStoreBlobProjectionSelector": { + "properties": { + "storageContainer": { + "type": "string", + "description": "Blob container to store projections in." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjectionSelector" + } + ], + "required": [ + "storageContainer" + ], + "description": "Abstract class to share properties between concrete selectors." + }, + "SearchIndexerKnowledgeStoreTableProjectionSelector": { + "properties": { + "tableName": { + "type": "string", + "description": "Name of the Azure table to store projected data in." + } + }, + "required": [ + "generatedKeyName", + "tableName" + ], + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreProjectionSelector" + } + ], + "description": "Description for what data to store in Azure Tables." + }, + "SearchIndexerKnowledgeStoreObjectProjectionSelector": { + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreBlobProjectionSelector" + } + ], + "description": "Projection definition for what data to store in Azure Blob." + }, + "SearchIndexerKnowledgeStoreFileProjectionSelector": { + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerKnowledgeStoreBlobProjectionSelector" + } + ], + "description": "Projection definition for what data to store in Azure Files." + }, + "DefaultCognitiveServicesAccount": { + "description": "An empty object that represents the default cognitive service resource for a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ] + }, + "CognitiveServicesAccountKey": { + "description": "A cognitive service resource provisioned with a key that is attached to a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CognitiveServicesByKey", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ], + "properties": { + "key": { + "type": "string", + "description": "The key used to provision the cognitive service resource attached to a skillset." + } + }, + "required": [ + "key" + ] + }, + "SearchIndexerSkill": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the skill." + }, + "name": { + "type": "string", + "description": "The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'." + }, + "description": { + "type": "string", + "description": "The description of the skill which describes the inputs, outputs, and usage of the skill." + }, + "context": { + "type": "string", + "description": "Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Inputs of the skills could be a column in the source data set, or the output of an upstream skill." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFieldMappingEntry" + }, + "description": "The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill." + } + }, + "required": [ + "@odata.type", + "inputs", + "outputs" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-predefined-skills" + }, + "description": "Base type for skills." + }, + "CustomEntity": { + "properties": { + "name": { + "type": "string", + "description": "The top-level entity descriptor. Matches in the skill output will be grouped by this name, and it should represent the \"normalized\" form of the text being found." + }, + "description": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "type": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "subtype": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "id": { + "type": "string", + "x-nullable": true, + "description": "This field can be used as a passthrough for custom metadata about the matched text(s). The value of this field will appear with every match of its entity in the skill output." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to character casing. Sample case insensitive matches of \"Microsoft\" could be: microsoft, microSoft, MICROSOFT." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Defaults to false. Boolean value denoting whether comparisons with the entity name should be sensitive to accent." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent characters that would still constitute a match with the entity name. The smallest possible fuzziness for any given match is returned. For instance, if the edit distance is set to 3, \"Windows10\" would still match \"Windows\", \"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case differences do NOT count towards fuzziness tolerance, but otherwise do." + }, + "defaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default case sensitivity value for this entity. It be used to change the default value of all aliases caseSensitive values." + }, + "defaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Changes the default accent sensitivity value for this entity. It be used to change the default value of all aliases accentSensitive values." + }, + "defaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Changes the default fuzzy edit distance value for this entity. It can be used to change the default value of all aliases fuzzyEditDistance values." + }, + "aliases": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntityAlias" + }, + "x-nullable": true, + "description": "An array of complex objects that can be used to specify alternative spellings or synonyms to the root entity name." + } + }, + "required": [ + "name" + ], + "description": "An object that contains information about the matches that were found, and related metadata." + }, + "CustomEntityAlias": { + "properties": { + "text": { + "type": "string", + "description": "The text of the alias." + }, + "caseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is case sensitive." + }, + "accentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "Determine if the alias is accent sensitive." + }, + "fuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "Determine the fuzzy edit distance of the alias." + } + }, + "required": [ + "text" + ], + "description": "A complex object that can be used to specify alternative spellings or synonyms to the root entity name." + }, + "InputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the input." + }, + "source": { + "type": "string", + "description": "The source of the input." + }, + "sourceContext": { + "type": "string", + "description": "The source context used for selecting recursive inputs." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "The recursive inputs used when creating a complex type." + } + }, + "required": [ + "name" + ], + "description": "Input field mapping for a skill." + }, + "OutputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the output defined by the skill." + }, + "targetName": { + "type": "string", + "description": "The target name of the output. It is optional and default to name." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/naming-rules" + }, + "description": "Output field mapping for a skill." + }, + "ConditionalSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ConditionalSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-conditional" + }, + "description": "A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output." + }, + "KeyPhraseExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/KeyPhraseExtractionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "maxKeyPhraseCount": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A number indicating how many key phrases to return. If absent, all identified key phrases will be returned." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-keyphrases" + }, + "description": "A skill that uses text analytics for key phrase extraction." + }, + "OcrSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.OcrSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/OcrSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "detectOrientation": { + "x-ms-client-name": "ShouldDetectOrientation", + "type": "boolean", + "default": false, + "description": "A value indicating to turn orientation detection on or not. Default is false." + }, + "lineEnding": { + "$ref": "#/definitions/OcrSkillLineEnding", + "description": "Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is \"space\"." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-ocr" + }, + "description": "A skill that extracts text from image files." + }, + "ImageAnalysisSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.ImageAnalysisSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/ImageAnalysisSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "visualFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/VisualFeature", + "x-nullable": false + }, + "description": "A list of visual features." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDetail", + "x-nullable": false + }, + "description": "A string indicating which domain-specific details to return." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-image-analysis" + }, + "description": "A skill that analyzes image files. It extracts a rich set of visual features based on the image content." + }, + "LanguageDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultCountryHint": { + "type": "string", + "x-nullable": true, + "description": "A country code to use as a hint to the language detection model if it cannot disambiguate the language." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-language-detection" + }, + "description": "A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis." + }, + "ShaperSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ShaperSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-shaper" + }, + "description": "A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." + }, + "MergeSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.MergeSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "insertPreTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the start of the merged text. By default, the tag is an empty space." + }, + "insertPostTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the end of the merged text. By default, the tag is an empty space." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textmerger" + }, + "description": "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part." + }, + "EntityRecognitionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityCategory", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/EntityRecognitionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "includeTypelessEntities": { + "type": "boolean", + "x-nullable": true, + "description": "Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" + }, + "description": "This skill is deprecated. Use the V3.EntityRecognitionSkill instead.", + "x-az-search-deprecated": true + }, + "SentimentSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SentimentSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment" + }, + "description": "This skill is deprecated. Use the V3.SentimentSkill instead.", + "x-az-search-deprecated": true + }, + "SentimentSkillV3": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "includeOpinionMining": { + "type": "boolean", + "default": false, + "description": "If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment-v3" + }, + "description": "Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as \"negative\", \"neutral\" and \"positive\") based on the highest confidence score found by the service at a sentence and document-level." + }, + "EntityLinkingSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityLinkingSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "minimum": 0.0, + "maximum": 1.0, + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-linking-v3" + }, + "description": "Using the Text Analytics API, extracts linked entities from text." + }, + "EntityRecognitionSkillV3": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "minimum": 0.0, + "maximum": 1.0, + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition-v3" + }, + "description": "Using the Text Analytics API, extracts entities of different types from text." + }, + "PIIDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.PIIDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "type": "string", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "minimum": 0.0, + "maximum": 1.0, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + }, + "maskingMode": { + "$ref": "#/definitions/PIIDetectionSkillMaskingMode", + "description": "A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'." + }, + "maskingCharacter": { + "type": "string", + "x-nullable": true, + "maxLength": 1, + "description": "The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'." + }, + "modelVersion": { + "type": "string", + "x-nullable": true, + "description": "The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary." + }, + "piiCategories": { + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "description": "A list of PII entity categories that should be extracted and masked." + }, + "domain": { + "type": "string", + "x-nullable": true, + "description": "If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-pii-detection" + }, + "description": "Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it." + }, + "SplitSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SplitSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "textSplitMode": { + "$ref": "#/definitions/TextSplitMode", + "x-nullable": false, + "description": "A value indicating which split mode to perform." + }, + "maximumPageLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired maximum page length. Default is 10000." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textsplit" + }, + "description": "A skill to split a string into chunks of text." + }, + "CustomEntityLookupSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.CustomEntityLookupSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/CustomEntityLookupSkillLanguage", + "x-nullable": true, + "description": "A value indicating which language code to use. Default is en." + }, + "entitiesDefinitionUri": { + "type": "string", + "x-nullable": true, + "description": "Path to a JSON or CSV file containing all the target text to match against. This entity definition is read at the beginning of an indexer run. Any updates to this file during an indexer run will not take effect until subsequent runs. This config must be accessible over HTTPS." + }, + "inlineEntitiesDefinition": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomEntity" + }, + "x-nullable": true, + "description": "The inline CustomEntity definition." + }, + "globalDefaultCaseSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultAccentSensitive": { + "type": "boolean", + "x-nullable": true, + "description": "A global flag for AccentSensitive. If AccentSensitive is not set in CustomEntity, this value will be the default value." + }, + "globalDefaultFuzzyEditDistance": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in CustomEntity, this value will be the default value." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/search/cognitive-search-skill-custom-entity-lookup" + }, + "description": "A skill looks for text from a custom, user-defined list of words and phrases." + }, + "TextTranslationSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultToLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents into for documents that don't specify the to language explicitly. " + }, + "defaultFromLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents from for documents that don't specify the from language explicitly." + }, + "suggestedFrom": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "x-nullable": true, + "description": "The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is en." + } + }, + "required": [ + "defaultToLanguageCode" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-text-translation" + }, + "description": "A skill to translate text from one language to another." + }, + "DocumentExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.DocumentExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "parsingMode": { + "type": "string", + "x-nullable": true, + "description": "The parsingMode for the skill. Will be set to 'default' if not defined." + }, + "dataToExtract": { + "type": "string", + "x-nullable": true, + "description": "The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined." + }, + "configuration": { + "type": "object", + "additionalProperties": true, + "x-nullable": true, + "description": "A dictionary of configurations for the skill." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-document-extraction" + }, + "description": "A skill that extracts content from a file within the enrichment pipeline." + }, + "WebApiSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "uri": { + "type": "string", + "description": "The url for the Web API." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the http request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the http request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired batch size which indicates number of documents." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "If set, the number of parallel calls that can be made to the Web API." + }, + "authResourceId": { + "type": "string", + "x-nullable": true, + "description": "Applies to custom skills that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the custom skill connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token." + }, + "authIdentity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for outbound connections. If an authResourceId is provided and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + }, + "required": [ + "uri" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-web-api" + }, + "description": "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code." + }, + "WebApiHttpHeaders": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of http request headers." + }, + "AmlSkill": { + "x-ms-client-name": "AzureMachineLearningSkill", + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.AmlSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "uri": { + "x-ms-client-name": "ScoringUri", + "type": "string", + "x-nullable": true, + "description": "(Required for no authentication or key authentication) The scoring URI of the AML service to which the JSON payload will be sent. Only the https URI scheme is allowed." + }, + "key": { + "x-ms-client-name": "AuthenticationKey", + "type": "string", + "x-nullable": true, + "description": "(Required for key authentication) The key for the AML service." + }, + "resourceId": { + "type": "string", + "x-nullable": true, + "description": "(Required for token authentication). The Azure Resource Manager resource ID of the AML service. It should be in the format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}." + }, + "timeout": { + "type": "string", + "format": "duration", + "x-nullable": true, + "description": "(Optional) When specified, indicates the timeout for the http client making the API call." + }, + "region": { + "type": "string", + "x-nullable": true, + "description": "(Optional for token authentication). The region the AML service is deployed in." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "(Optional) When specified, indicates the number of calls the indexer will make in parallel to the endpoint you have provided. You can decrease this value if your endpoint is failing under too high of a request load, or raise it if your endpoint is able to accept more requests and you would like an increase in the performance of the indexer. If not set, a default value of 5 is used. The degreeOfParallelism can be set to a maximum of 10 and a minimum of 1." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/azure/search/cognitive-search-aml-skill" + }, + "description": "The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment." + }, + "ListSkillsetsResult": { + "properties": { + "value": { + "x-ms-client-name": "Skillsets", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillsets defined in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a list skillset request. If successful, it includes the full definitions of all skillsets." + }, + "TextSplitMode": { + "type": "string", + "enum": [ + "pages", + "sentences" + ], + "x-ms-enum": { + "name": "TextSplitMode", + "modelAsString": true, + "values": [ + { + "value": "pages", + "name": "Pages", + "description": "Split the text into individual pages." + }, + { + "value": "sentences", + "name": "Sentences", + "description": "Split the text into individual sentences." + } + ] + }, + "description": "A value indicating which split mode to perform." + }, + "VisualFeature": { + "type": "string", + "enum": [ + "adult", + "brands", + "categories", + "description", + "faces", + "objects", + "tags" + ], + "x-ms-enum": { + "name": "VisualFeature", + "modelAsString": true, + "values": [ + { + "value": "adult", + "name": "Adult", + "description": "Visual features recognized as adult persons." + }, + { + "value": "brands", + "name": "Brands", + "description": "Visual features recognized as commercial brands." + }, + { + "value": "categories", + "name": "Categories", + "description": "Categories." + }, + { + "value": "description", + "name": "Description", + "description": "Description." + }, + { + "value": "faces", + "name": "Faces", + "description": "Visual features recognized as people faces." + }, + { + "value": "objects", + "name": "Objects", + "description": "Visual features recognized as objects." + }, + { + "value": "tags", + "name": "Tags", + "description": "Tags." + } + ] + }, + "description": "The strings indicating what visual feature types to return." + }, + "ImageDetail": { + "type": "string", + "enum": [ + "celebrities", + "landmarks" + ], + "x-ms-enum": { + "name": "ImageDetail", + "modelAsString": true, + "values": [ + { + "value": "celebrities", + "name": "Celebrities", + "description": "Details recognized as celebrities." + }, + { + "value": "landmarks", + "name": "Landmarks", + "description": "Details recognized as landmarks." + } + ] + }, + "description": "A string indicating which domain-specific details to return." + }, + "EntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person", + "quantity", + "datetime", + "url", + "email" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": true, + "values": [ + { + "value": "location", + "name": "Location", + "description": "Entities describing a physical location." + }, + { + "value": "organization", + "name": "Organization", + "description": "Entities describing an organization." + }, + { + "value": "person", + "name": "Person", + "description": "Entities describing a person." + }, + { + "value": "quantity", + "name": "Quantity", + "description": "Entities describing a quantity." + }, + { + "value": "datetime", + "name": "Datetime", + "description": "Entities describing a date and time." + }, + { + "value": "url", + "name": "Url", + "description": "Entities describing a URL." + }, + { + "value": "email", + "name": "Email", + "description": "Entities describing an email address." + } + ] + }, + "description": "A string indicating what entity categories to return." + }, + "PIIDetectionSkillMaskingMode": { + "type": "string", + "enum": [ + "none", + "replace" + ], + "x-ms-enum": { + "name": "PIIDetectionSkillMaskingMode", + "modelAsString": true, + "values": [ + { + "value": "none", + "name": "None", + "description": "No masking occurs and the maskedText output will not be returned." + }, + { + "value": "replace", + "name": "Replace", + "description": "Replaces the detected entities with the character given in the maskingCharacter parameter. The character will be repeated to the length of the detected entity so that the offsets will correctly correspond to both the input text as well as the output maskedText." + } + ] + }, + "description": "A string indicating what maskingMode to use to mask the personal information detected in the input text." + }, + "SentimentSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "it", + "no", + "pl", + "pt-PT", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "SentimentSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "Deprecated. The language codes supported for input text by SentimentSkill.", + "x-az-search-deprecated": true + }, + "KeyPhraseExtractionSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv" + ], + "x-ms-enum": { + "name": "KeyPhraseExtractionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + } + ] + }, + "description": "The language codes supported for input text by KeyPhraseExtractionSkill." + }, + "OcrSkillLanguage": { + "type": "string", + "enum": [ + "af", + "sq", + "anp", + "ar", + "ast", + "awa", + "az", + "bfy", + "eu", + "be", + "be-cyrl", + "be-latn", + "bho", + "bi", + "brx", + "bs", + "bra", + "br", + "bg", + "bns", + "bua", + "ca", + "ceb", + "rab", + "ch", + "hne", + "zh-Hans", + "zh-Hant", + "kw", + "co", + "crh", + "hr", + "cs", + "da", + "prs", + "dhi", + "doi", + "nl", + "en", + "myv", + "et", + "fo", + "fj", + "fil", + "fi", + "fr", + "fur", + "gag", + "gl", + "de", + "gil", + "gon", + "el", + "kl", + "gvr", + "ht", + "hlb", + "hni", + "bgc", + "haw", + "hi", + "mww", + "hoc", + "hu", + "is", + "smn", + "id", + "ia", + "iu", + "ga", + "it", + "ja", + "Jns", + "jv", + "kea", + "kac", + "xnr", + "krc", + "kaa-cyrl", + "kaa", + "csb", + "kk-cyrl", + "kk-latn", + "klr", + "kha", + "quc", + "ko", + "kfq", + "kpy", + "kos", + "kum", + "ku-arab", + "ku-latn", + "kru", + "ky", + "lkt", + "la", + "lt", + "dsb", + "smj", + "lb", + "bfz", + "ms", + "mt", + "kmj", + "gv", + "mi", + "mr", + "mn", + "cnr-cyrl", + "cnr-latn", + "nap", + "ne", + "niu", + "nog", + "sme", + "nb", + "no", + "oc", + "os", + "ps", + "fa", + "pl", + "pt", + "pa", + "ksh", + "ro", + "rm", + "ru", + "sck", + "sm", + "sa", + "sat", + "sco", + "gd", + "sr", + "sr-Cyrl", + "sr-Latn", + "xsr", + "srx", + "sms", + "sk", + "sl", + "so", + "sma", + "es", + "sw", + "sv", + "tg", + "tt", + "tet", + "thf", + "to", + "tr", + "tk", + "tyv", + "hsb", + "ur", + "ug", + "uz-arab", + "uz-cyrl", + "uz", + "vo", + "wae", + "cy", + "fy", + "yua", + "za", + "zu", + "unk" + ], + "x-ms-enum": { + "name": "OcrSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "af", + "description": "Afrikaans" + }, + { + "value": "sq", + "description": "Albanian" + }, + { + "value": "anp", + "description": "Angika (Devanagiri)" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "ast", + "description": "Asturian" + }, + { + "value": "awa", + "description": "Awadhi-Hindi (Devanagiri)" + }, + { + "value": "az", + "description": "Azerbaijani (Latin)" + }, + { + "value": "bfy", + "description": "Bagheli" + }, + { + "value": "eu", + "description": "Basque" + }, + { + "value": "be", + "description": "Belarusian (Cyrillic and Latin)" + }, + { + "value": "be-cyrl", + "description": "Belarusian (Cyrillic)" + }, + { + "value": "be-latn", + "description": "Belarusian (Latin)" + }, + { + "value": "bho", + "description": "Bhojpuri-Hindi (Devanagiri)" + }, + { + "value": "bi", + "description": "Bislama" + }, + { + "value": "brx", + "description": "Bodo (Devanagiri)" + }, + { + "value": "bs", + "description": "Bosnian Latin" + }, + { + "value": "bra", + "description": "Brajbha" + }, + { + "value": "br", + "description": "Breton" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "bns", + "description": "Bundeli" + }, + { + "value": "bua", + "description": "Buryat (Cyrillic)" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "ceb", + "description": "Cebuano" + }, + { + "value": "rab", + "description": "Chamling" + }, + { + "value": "ch", + "description": "Chamorro" + }, + { + "value": "hne", + "description": "Chhattisgarhi (Devanagiri)" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + }, + { + "value": "kw", + "description": "Cornish" + }, + { + "value": "co", + "description": "Corsican" + }, + { + "value": "crh", + "description": "Crimean Tatar (Latin)" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "prs", + "description": "Dari" + }, + { + "value": "dhi", + "description": "Dhimal (Devanagiri)" + }, + { + "value": "doi", + "description": "Dogri (Devanagiri)" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "myv", + "description": "Erzya (Cyrillic)" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fo", + "description": "Faroese" + }, + { + "value": "fj", + "description": "Fijian" + }, + { + "value": "fil", + "description": "Filipino" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "fur", + "description": "Frulian" + }, + { + "value": "gag", + "description": "Gagauz (Latin)" + }, + { + "value": "gl", + "description": "Galician" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "gil", + "description": "Gilbertese" + }, + { + "value": "gon", + "description": "Gondi (Devanagiri)" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "kl", + "description": "Greenlandic" + }, + { + "value": "gvr", + "description": "Gurung (Devanagiri)" + }, + { + "value": "ht", + "description": "Haitian Creole" + }, + { + "value": "hlb", + "description": "Halbi (Devanagiri)" + }, + { + "value": "hni", + "description": "Hani" + }, + { + "value": "bgc", + "description": "Haryanvi" + }, + { + "value": "haw", + "description": "Hawaiian" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "mww", + "description": "Hmong Daw (Latin)" + }, + { + "value": "hoc", + "description": "Ho (Devanagiri)" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "smn", + "description": "Inari Sami" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "ia", + "description": "Interlingua" + }, + { + "value": "iu", + "description": "Inuktitut (Latin)" + }, + { + "value": "ga", + "description": "Irish" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "Jns", + "description": "Jaunsari (Devanagiri)" + }, + { + "value": "jv", + "description": "Javanese" + }, + { + "value": "kea", + "description": "Kabuverdianu" + }, + { + "value": "kac", + "description": "Kachin (Latin)" + }, + { + "value": "xnr", + "description": "Kangri (Devanagiri)" + }, + { + "value": "krc", + "description": "Karachay-Balkar" + }, + { + "value": "kaa-cyrl", + "description": "Kara-Kalpak (Cyrillic)" + }, + { + "value": "kaa", + "description": "Kara-Kalpak (Latin)" + }, + { + "value": "csb", + "description": "Kashubian" + }, + { + "value": "kk-cyrl", + "description": "Kazakh (Cyrillic)" + }, + { + "value": "kk-latn", + "description": "Kazakh (Latin)" + }, + { + "value": "klr", + "description": "Khaling" + }, + { + "value": "kha", + "description": "Khasi" + }, + { + "value": "quc", + "description": "K'iche'" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "kfq", + "description": "Korku" + }, + { + "value": "kpy", + "description": "Koryak" + }, + { + "value": "kos", + "description": "Kosraean" + }, + { + "value": "kum", + "description": "Kumyk (Cyrillic)" + }, + { + "value": "ku-arab", + "description": "Kurdish (Arabic)" + }, + { + "value": "ku-latn", + "description": "Kurdish (Latin)" + }, + { + "value": "kru", + "description": "Kurukh (Devanagiri)" + }, + { + "value": "ky", + "description": "Kyrgyz (Cyrillic)" + }, + { + "value": "lkt", + "description": "Lakota" + }, + { + "value": "la", + "description": "Latin" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "dsb", + "description": "Lower Sorbian" + }, + { + "value": "smj", + "description": "Lule Sami" + }, + { + "value": "lb", + "description": "Luxembourgish" + }, + { + "value": "bfz", + "description": "Mahasu Pahari (Devanagiri)" + }, + { + "value": "ms", + "description": "Malay (Latin)" + }, + { + "value": "mt", + "description": "Maltese" + }, + { + "value": "kmj", + "description": "Malto (Devanagiri)" + }, + { + "value": "gv", + "description": "Manx" + }, + { + "value": "mi", + "description": "Maori" + }, + { + "value": "mr", + "description": "Marathi" + }, + { + "value": "mn", + "description": "Mongolian (Cyrillic)" + }, + { + "value": "cnr-cyrl", + "description": "Montenegrin (Cyrillic)" + }, + { + "value": "cnr-latn", + "description": "Montenegrin (Latin)" + }, + { + "value": "nap", + "description": "Neapolitan" + }, + { + "value": "ne", + "description": "Nepali" + }, + { + "value": "niu", + "description": "Niuean" + }, + { + "value": "nog", + "description": "Nogay" + }, + { + "value": "sme", + "description": "Northern Sami (Latin)" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "no", + "description": "Norwegian" + }, + { + "value": "oc", + "description": "Occitan" + }, + { + "value": "os", + "description": "Ossetic" + }, + { + "value": "ps", + "description": "Pashto" + }, + { + "value": "fa", + "description": "Persian" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "pa", + "description": "Punjabi (Arabic)" + }, + { + "value": "ksh", + "description": "Ripuarian" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "rm", + "description": "Romansh" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sck", + "description": "Sadri (Devanagiri)" + }, + { + "value": "sm", + "description": "Samoan (Latin)" + }, + { + "value": "sa", + "description": "Sanskrit (Devanagiri)" + }, + { + "value": "sat", + "description": "Santali (Devanagiri)" + }, + { + "value": "sco", + "description": "Scots" + }, + { + "value": "gd", + "description": "Scottish Gaelic" + }, + { + "value": "sr", + "description": "Serbian (Latin)" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin)" + }, + { + "value": "xsr", + "description": "Sherpa (Devanagiri)" + }, + { + "value": "srx", + "description": "Sirmauri (Devanagiri)" + }, + { + "value": "sms", + "description": "Skolt Sami" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "so", + "description": "Somali (Arabic)" + }, + { + "value": "sma", + "description": "Southern Sami" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sw", + "description": "Swahili (Latin)" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tg", + "description": "Tajik (Cyrillic)" + }, + { + "value": "tt", + "description": "Tatar (Latin)" + }, + { + "value": "tet", + "description": "Tetum" + }, + { + "value": "thf", + "description": "Thangmi" + }, + { + "value": "to", + "description": "Tongan" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "tk", + "description": "Turkmen (Latin)" + }, + { + "value": "tyv", + "description": "Tuvan" + }, + { + "value": "hsb", + "description": "Upper Sorbian" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "ug", + "description": "Uyghur (Arabic)" + }, + { + "value": "uz-arab", + "description": "Uzbek (Arabic)" + }, + { + "value": "uz-cyrl", + "description": "Uzbek (Cyrillic)" + }, + { + "value": "uz", + "description": "Uzbek (Latin)" + }, + { + "value": "vo", + "description": "Volapük" + }, + { + "value": "wae", + "description": "Walser" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "fy", + "description": "Western Frisian" + }, + { + "value": "yua", + "description": "Yucatec Maya" + }, + { + "value": "za", + "description": "Zhuang" + }, + { + "value": "zu", + "description": "Zulu" + }, + { + "value": "unk", + "description": "Unknown (All)" + } + ] + }, + "description": "The language codes supported for input by OcrSkill." + }, + "OcrSkillLineEnding": { + "type": "string", + "enum": [ + "space", + "carriageReturn", + "lineFeed", + "carriageReturnLineFeed" + ], + "x-ms-enum": { + "name": "LineEnding", + "modelAsString": true, + "values": [ + { + "value": "space", + "name": "Space", + "description": "Lines are separated by a single space character." + }, + { + "value": "carriageReturn", + "name": "CarriageReturn", + "description": "Lines are separated by a carriage return ('\\r') character." + }, + { + "value": "lineFeed", + "name": "LineFeed", + "description": "Lines are separated by a single line feed ('\\n') character." + }, + { + "value": "carriageReturnLineFeed", + "name": "CarriageReturnLineFeed", + "description": "Lines are separated by a carriage return and a line feed ('\\r\\n') character." + } + ] + }, + "description": "Defines the sequence of characters to use between the lines of text recognized by the OCR skill. The default value is \"space\"." + }, + "SplitSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "SplitSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by SplitSkill." + }, + "CustomEntityLookupSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "CustomEntityLookupSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by CustomEntityLookupSkill." + }, + "EntityRecognitionSkillLanguage": { + "type": "string", + "enum": [ + "ar", + "cs", + "zh-Hans", + "zh-Hant", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "EntityRecognitionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "zh-Hans", + "description": "Chinese-Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese-Traditional" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "Deprecated. The language codes supported for input text by EntityRecognitionSkill.", + "x-az-search-deprecated": true + }, + "TextTranslationSkillLanguage": { + "type": "string", + "enum": [ + "af", + "ar", + "bn", + "bs", + "bg", + "yue", + "ca", + "zh-Hans", + "zh-Hant", + "hr", + "cs", + "da", + "nl", + "en", + "et", + "fj", + "fil", + "fi", + "fr", + "de", + "el", + "ht", + "he", + "hi", + "mww", + "hu", + "is", + "id", + "it", + "ja", + "sw", + "tlh", + "tlh-Latn", + "tlh-Piqd", + "ko", + "lv", + "lt", + "mg", + "ms", + "mt", + "nb", + "fa", + "pl", + "pt", + "pt-br", + "pt-PT", + "otq", + "ro", + "ru", + "sm", + "sr-Cyrl", + "sr-Latn", + "sk", + "sl", + "es", + "sv", + "ty", + "ta", + "te", + "th", + "to", + "tr", + "uk", + "ur", + "vi", + "cy", + "yua", + "ga", + "kn", + "mi", + "ml", + "pa" + ], + "x-ms-enum": { + "name": "TextTranslationSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "af", + "description": "Afrikaans" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "bn", + "description": "Bangla" + }, + { + "value": "bs", + "description": "Bosnian (Latin)" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "yue", + "description": "Cantonese (Traditional)" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fj", + "description": "Fijian" + }, + { + "value": "fil", + "description": "Filipino" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "ht", + "description": "Haitian Creole" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "mww", + "description": "Hmong Daw" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "sw", + "description": "Kiswahili" + }, + { + "value": "tlh", + "description": "Klingon" + }, + { + "value": "tlh-Latn", + "description": "Klingon (Latin script)" + }, + { + "value": "tlh-Piqd", + "description": "Klingon (Klingon script)" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "mg", + "description": "Malagasy" + }, + { + "value": "ms", + "description": "Malay" + }, + { + "value": "mt", + "description": "Maltese" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "fa", + "description": "Persian" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "pt-br", + "description": "Portuguese (Brazil)" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "otq", + "description": "Queretaro Otomi" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sm", + "description": "Samoan" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin)" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "ty", + "description": "Tahitian" + }, + { + "value": "ta", + "description": "Tamil" + }, + { + "value": "te", + "description": "Telugu" + }, + { + "value": "th", + "description": "Thai" + }, + { + "value": "to", + "description": "Tongan" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "uk", + "description": "Ukrainian" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "vi", + "description": "Vietnamese" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "yua", + "description": "Yucatec Maya" + }, + { + "value": "ga", + "description": "Irish" + }, + { + "value": "kn", + "description": "Kannada" + }, + { + "value": "mi", + "description": "Maori" + }, + { + "value": "ml", + "description": "Malayalam" + }, + { + "value": "pa", + "description": "Punjabi" + } + ] + }, + "description": "The language codes supported for input text by TextTranslationSkill." + }, + "ImageAnalysisSkillLanguage": { + "type": "string", + "enum": [ + "ar", + "az", + "bg", + "bs", + "ca", + "cs", + "cy", + "da", + "de", + "el", + "en", + "es", + "et", + "eu", + "fi", + "fr", + "ga", + "gl", + "he", + "hi", + "hr", + "hu", + "id", + "it", + "ja", + "kk", + "ko", + "lt", + "lv", + "mk", + "ms", + "nb", + "nl", + "pl", + "prs", + "pt-BR", + "pt", + "pt-PT", + "ro", + "ru", + "sk", + "sl", + "sr-Cyrl", + "sr-Latn", + "sv", + "th", + "tr", + "uk", + "vi", + "zh", + "zh-Hans", + "zh-Hant" + ], + "x-ms-enum": { + "name": "ImageAnalysisSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "az", + "description": "Azerbaijani" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "bs", + "description": "Bosnian Latin" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "eu", + "description": "Basque" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "ga", + "description": "Irish" + }, + { + "value": "gl", + "description": "Galician" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "kk", + "description": "Kazakh" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "mk", + "description": "Macedonian" + }, + { + "value": "ms", + "description": "Malay Malaysia" + }, + { + "value": "nb", + "description": "Norwegian (Bokmal)" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "prs", + "description": "Dari" + }, + { + "value": "pt-BR", + "description": "Portuguese-Brazil" + }, + { + "value": "pt", + "description": "Portuguese-Portugal" + }, + { + "value": "pt-PT", + "description": "Portuguese-Portugal" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "sr-Cyrl", + "description": "Serbian - Cyrillic RS" + }, + { + "value": "sr-Latn", + "description": "Serbian - Latin RS" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "th", + "description": "Thai" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "uk", + "description": "Ukrainian" + }, + { + "value": "vi", + "description": "Vietnamese" + }, + { + "value": "zh", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + } + ] + }, + "description": "The language codes supported for input by ImageAnalysisSkill." + }, + "SynonymMap": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the synonym map." + }, + "format": { + "type": "string", + "enum": [ + "solr" + ], + "x-ms-enum": { + "name": "SynonymMapFormat", + "modelAsString": false, + "values": [ + { + "value": "solr", + "name": "Solr", + "description": "Selects the SOLR format for synonym maps." + } + ] + }, + "description": "The format of the synonym map. Only the 'solr' format is currently supported." + }, + "synonyms": { + "type": "string", + "description": "A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + }, + "x-nullable": true + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the synonym map." + } + }, + "required": [ + "name", + "format", + "synonyms" + ], + "description": "Represents a synonym map definition." + }, + "ListSynonymMapsResult": { + "properties": { + "value": { + "x-ms-client-name": "SynonymMaps", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The synonym maps in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps." + }, + "SearchResourceEncryptionKey": { + "properties": { + "keyVaultKeyName": { + "x-ms-client-name": "keyName", + "type": "string", + "description": "The name of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultKeyVersion": { + "x-ms-client-name": "keyVersion", + "type": "string", + "description": "The version of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultUri": { + "x-ms-client-name": "vaultUri", + "type": "string", + "description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net." + }, + "accessCredentials": { + "$ref": "#/definitions/AzureActiveDirectoryApplicationCredentials", + "description": "Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.", + "externalDocs": { + "url": "https://aka.ms/azure-search-msi" + } + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If \"none\" is specified, the value of this property is cleared." + } + }, + "required": [ + "keyVaultKeyName", + "keyVaultKeyVersion", + "keyVaultUri" + ], + "description": "A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym maps." + }, + "SearchIndexerCache": { + "properties": { + "storageConnectionString": { + "type": "string", + "description": "The connection string to the storage account where the cache data will be persisted." + }, + "enableReprocessing": { + "type": "boolean", + "x-nullable": true, + "description": "Specifies whether incremental reprocessing is enabled." + }, + "identity": { + "$ref": "#/definitions/SearchIndexerDataIdentity", + "x-nullable": true, + "description": "The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to \"none\", the value of this property is cleared." + } + } + }, + "AzureActiveDirectoryApplicationCredentials": { + "properties": { + "applicationId": { + "type": "string", + "description": "An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application." + }, + "applicationSecret": { + "type": "string", + "description": "The authentication key of the specified AAD application." + } + }, + "required": [ + "applicationId" + ], + "description": "Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault." + }, + "ServiceStatistics": { + "properties": { + "counters": { + "$ref": "#/definitions/ServiceCounters", + "description": "Service level resource counters." + }, + "limits": { + "$ref": "#/definitions/ServiceLimits", + "description": "Service level general limits." + } + }, + "required": [ + "counters", + "limits" + ], + "description": "Response from a get service statistics request. If successful, it includes service level counters and limits." + }, + "ServiceCounters": { + "properties": { + "aliasesCount": { + "x-ms-client-name": "aliasCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of aliases." + }, + "documentCount": { + "x-ms-client-name": "documentCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of documents across all indexes in the service." + }, + "indexesCount": { + "x-ms-client-name": "indexCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexes." + }, + "indexersCount": { + "x-ms-client-name": "indexerCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexers." + }, + "dataSourcesCount": { + "x-ms-client-name": "dataSourceCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of data sources." + }, + "storageSize": { + "x-ms-client-name": "storageSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total size of used storage in bytes." + }, + "synonymMaps": { + "x-ms-client-name": "synonymMapCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of synonym maps." + }, + "skillsetCount": { + "x-ms-client-name": "skillsetCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of skillsets." + } + }, + "required": [ + "documentCount", + "indexesCount", + "indexersCount", + "dataSourcesCount", + "storageSize", + "synonymMaps" + ], + "description": "Represents service-level resource counters and quotas." + }, + "ServiceLimits": { + "properties": { + "maxFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum allowed fields per index." + }, + "maxFieldNestingDepthPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3." + }, + "maxComplexCollectionFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index." + }, + "maxComplexObjectsInCollectionsPerDocument": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of objects in complex collections allowed per document." + } + }, + "description": "Represents various service level limits." + }, + "ResourceCounter": { + "properties": { + "usage": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "description": "The resource usage amount." + }, + "quota": { + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The resource amount quota." + } + }, + "required": [ + "usage" + ], + "description": "Represents a resource's usage and quota." + }, + "SearchError": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "A human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchError" + }, + "readOnly": true, + "description": "An array of details about specific errors that led to this reported error." + } + }, + "required": [ + "message" + ], + "description": "Describes an error condition for the Azure Cognitive Search API." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "x-ms-parameter-location": "method" + }, + "PreferHeaderParameter": { + "name": "Prefer", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "return=representation" + ], + "description": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + }, + "DisableCacheReprocessingChangeDetectionParameter": { + "name": "disableCacheReprocessingChangeDetection", + "in": "query", + "required": false, + "type": "boolean", + "description": "Disables cache reprocessing change detection.", + "x-ms-parameter-location": "method" + }, + "IgnoreResetRequirementsParameter": { + "name": "ignoreResetRequirements", + "x-ms-client-name": "skipIndexerResetRequirementForCache", + "in": "query", + "required": false, + "type": "boolean", + "description": "Ignores cache reset requirements.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/readme.md b/specification/search/data-plane/Azure.Search/readme.md index 4cea0b6f6fb0..fa11e34a8a14 100644 --- a/specification/search/data-plane/Azure.Search/readme.md +++ b/specification/search/data-plane/Azure.Search/readme.md @@ -26,7 +26,7 @@ These are the global settings for SearchServiceClient and SearchIndexClient. title: SearchClient opt-in-extensible-enums: true openapi-type: data-plane -tag: package-2021-04-30-preview +tag: package-2023-07-01-preview directive: - where: @@ -171,6 +171,45 @@ directive: - RequiredReadOnlyProperties ``` +### Tag: package-2023-07-01-preview + +These settings apply only when `--tag=package-2023-07-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2023-07-01-preview' +input-file: +- preview/2023-07-01-Preview/searchservice.json +- preview/2023-07-01-Preview/searchindex.json +``` + +#### Rename one of SearchError definitions + +SearchError is duplicated between two swaggers, rename one of them + +``` yaml $(tag) == 'package-2023-07-01-preview' +directive: +- from: preview/2023-07-01-Preview/searchservice.json + where: $.definitions.SearchError + transform: $["x-ms-client-name"] = "SearchServiceError" +``` + +### Tag: package-2023-07-searchservice-preview + +These settings apply only when `--tag=package-2023-07-searchservice-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2023-07-searchservice-preview' +input-file: +- preview/2023-07-01-Preview/searchservice.json +``` + +### Tag: package-2023-07-searchindex-preview + +These settings apply only when `--tag=package-2023-07-searchindex-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2023-07-searchindex-preview' +input-file: +- preview/2023-07-01-Preview/searchindex.json +``` + ### Tag: package-2021-04-30-preview These settings apply only when `--tag=package-2021-04-30-preview` is specified on the command line. @@ -763,6 +802,8 @@ require: $(this-folder)/../../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/preview/2023-07-01-Preview/searchservice.json + - $(this-folder)/preview/2023-07-01-Preview/searchindex.json - $(this-folder)/preview/2021-04-30-Preview/searchservice.json - $(this-folder)/preview/2021-04-30-Preview/searchindex.json - $(this-folder)/preview/2020-06-30-Preview/searchservice.json From fd36ce7f77f1c0b4d4031cdff55c145abd80f873 Mon Sep 17 00:00:00 2001 From: Anjikya Tiwari <116218102+ajtiwari07@users.noreply.github.com> Date: Thu, 4 May 2023 20:06:10 -0700 Subject: [PATCH 24/79] API 2023-04-01: A new property "storage-subscription-id" added in redisConfiguration (#23726) * Adds base for updating Microsoft.Cache from version stable/2022-06-01 to version 2023-04-01 * Updates readme * Updates API version in new specs and examples * Added new storage-subscription-id parameter for api version 2023-04-01 * test examples modified with new parameter * Post review rephrasing of new parameter desc. * Trigger Build --- .../RedisCacheAsyncOperationStatus.json | 22 + .../RedisCacheCheckNameAvailability.json | 13 + .../2023-04-01/examples/RedisCacheCreate.json | 205 ++ .../RedisCacheCreateDefaultVersion.json | 204 ++ .../RedisCacheCreateLatestVersion.json | 205 ++ .../2023-04-01/examples/RedisCacheDelete.json | 17 + ...sCacheDeletePrivateEndpointConnection.json | 13 + .../2023-04-01/examples/RedisCacheExport.json | 23 + .../RedisCacheFirewallRuleCreate.json | 39 + .../RedisCacheFirewallRuleDelete.json | 13 + .../examples/RedisCacheFirewallRuleGet.json | 22 + .../examples/RedisCacheFirewallRulesList.json | 34 + .../examples/RedisCacheForceReboot.json | 23 + .../2023-04-01/examples/RedisCacheGet.json | 76 + ...edisCacheGetPrivateEndpointConnection.json | 29 + .../2023-04-01/examples/RedisCacheImport.json | 24 + .../RedisCacheLinkedServer_Create.json | 48 + .../RedisCacheLinkedServer_Delete.json | 17 + .../examples/RedisCacheLinkedServer_Get.json | 26 + .../examples/RedisCacheLinkedServer_List.json | 42 + .../2023-04-01/examples/RedisCacheList.json | 57 + .../RedisCacheListByResourceGroup.json | 36 + .../examples/RedisCacheListKeys.json | 16 + ...isCacheListPrivateEndpointConnections.json | 49 + .../RedisCacheListPrivateLinkResources.json | 30 + .../RedisCacheListUpgradeNotifications.json | 22 + .../examples/RedisCacheOperations.json | 643 ++++ ...edisCachePatchSchedulesCreateOrUpdate.json | 68 + .../RedisCachePatchSchedulesDelete.json | 13 + .../examples/RedisCachePatchSchedulesGet.json | 32 + .../RedisCachePatchSchedulesList.json | 35 + ...edisCachePutPrivateEndpointConnection.json | 55 + .../examples/RedisCacheRegenerateKey.json | 19 + .../2023-04-01/examples/RedisCacheUpdate.json | 125 + .../stable/2023-04-01/redis.json | 2858 +++++++++++++++++ .../redis/resource-manager/readme.md | 13 +- 36 files changed, 5164 insertions(+), 2 deletions(-) create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheAsyncOperationStatus.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCheckNameAvailability.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreate.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreateDefaultVersion.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreateLatestVersion.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheDelete.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheDeletePrivateEndpointConnection.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheExport.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleCreate.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleDelete.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleGet.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRulesList.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheForceReboot.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheGet.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheGetPrivateEndpointConnection.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheImport.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Create.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Delete.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Get.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_List.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheList.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListByResourceGroup.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListKeys.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListPrivateEndpointConnections.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListPrivateLinkResources.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListUpgradeNotifications.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheOperations.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesDelete.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesGet.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesList.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePutPrivateEndpointConnection.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheRegenerateKey.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheUpdate.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/redis.json diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheAsyncOperationStatus.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheAsyncOperationStatus.json new file mode 100644 index 000000000000..fc03c7dce041 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheAsyncOperationStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "location": "East US", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "operationId": "c7ba2bf5-5939-4d79-b037-2964ccf097da" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Cache/locations/East US/asyncOperations/c7ba2bf5-5939-4d79-b037-2964ccf097da", + "name": "c7ba2bf5-5939-4d79-b037-2964ccf097da", + "status": "Succeeded", + "startTime": null, + "endTime": null, + "percentComplete": null, + "properties": null, + "error": null + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCheckNameAvailability.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCheckNameAvailability.json new file mode 100644 index 000000000000..3c4af7d4b4b0 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCheckNameAvailability.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "type": "Microsoft.Cache/Redis", + "name": "cacheName" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreate.json new file mode 100644 index 000000000000..9ea7f1dbdca0 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreate.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "zones": [ + "1" + ], + "properties": { + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "redisVersion": "4", + "enableNonSslPort": true, + "shardCount": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "subnetId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1", + "staticIP": "192.168.0.5", + "minimumTlsVersion": "1.2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "4.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "4.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreateDefaultVersion.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreateDefaultVersion.json new file mode 100644 index 000000000000..919fa0e8b16b --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreateDefaultVersion.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "zones": [ + "1" + ], + "properties": { + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": true, + "shardCount": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "subnetId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1", + "staticIP": "192.168.0.5", + "minimumTlsVersion": "1.2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreateLatestVersion.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreateLatestVersion.json new file mode 100644 index 000000000000..5ccb0cb15cf1 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheCreateLatestVersion.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "zones": [ + "1" + ], + "properties": { + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "redisVersion": "Latest", + "enableNonSslPort": true, + "shardCount": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "subnetId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1", + "staticIP": "192.168.0.5", + "minimumTlsVersion": "1.2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheDelete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheDelete.json new file mode 100644 index 000000000000..c164901858de --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheDeletePrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..74e09adb77c3 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheDeletePrivateEndpointConnection.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2023-04-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheExport.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheExport.json new file mode 100644 index 000000000000..92f6fbd84884 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheExport.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "format": "RDB", + "prefix": "datadump1", + "container": "https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters", + "storage-subscription-id": "storageSubId" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleCreate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleCreate.json new file mode 100644 index 000000000000..5cbc6e430909 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleCreate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "ruleName": "rule1", + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "cache1/rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "cache1/rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleDelete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleDelete.json new file mode 100644 index 000000000000..80ae60ab6d96 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "ruleName": "rule1", + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleGet.json new file mode 100644 index 000000000000..4c88dab0cf4f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "ruleName": "rule1", + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "cache1/rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRulesList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRulesList.json new file mode 100644 index 000000000000..08e8c6b0bfc4 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheFirewallRulesList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule2", + "name": "rule2", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.169.1.0", + "endIP": "192.169.1.255" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheForceReboot.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheForceReboot.json new file mode 100644 index 000000000000..a6607c041fd3 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheForceReboot.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "shardId": 0, + "rebootType": "AllNodes", + "ports": [ + 13000, + 15001 + ] + } + }, + "responses": { + "200": { + "body": { + "message": "reboot operation enqueued" + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheGet.json new file mode 100644 index 000000000000..1f387a68e899 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheGet.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "redisVersion": "3.2", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 3 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": {}, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "linkedServers": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2" + } + ], + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ], + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/privateEndpointConnections/cachePec", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/cachePe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Please approve my connection", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheGetPrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..54af40947b1f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheGetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheImport.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheImport.json new file mode 100644 index 000000000000..529968a1bc87 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheImport.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "format": "RDB", + "files": [ + "http://fileuris.contoso.com/pathtofile1" + ], + "storage-subscription-id": "storageSubId" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Create.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Create.json new file mode 100644 index 000000000000..2aa45b448197 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "linkedServerName": "cache2", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "serverRole": "Secondary" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "geoReplicatedPrimaryHostName": "cache2.geo.redis.cache.windows.net", + "primaryHostName": "cache1.redis.cache.windows.net", + "provisioningState": "Creating", + "serverRole": "Secondary" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "geoReplicatedPrimaryHostName": "cache2.geo.redis.cache.windows.net", + "primaryHostName": "cache1.redis.cache.windows.net", + "provisioningState": "Creating", + "serverRole": "Secondary" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Delete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Delete.json new file mode 100644 index 000000000000..2faf02cb4460 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "linkedServerName": "cache2", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Get.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Get.json new file mode 100644 index 000000000000..6c99899239cb --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "linkedServerName": "cache2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "geoReplicatedPrimaryHostName": "cache2.geo.redis.cache.windows.net", + "primaryHostName": "cache1.redis.cache.windows.net", + "provisioningState": "Succeeded", + "serverRole": "Secondary" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_List.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_List.json new file mode 100644 index 000000000000..7b5be7b378af --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheLinkedServer_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "geoReplicatedPrimaryHostName": "cache2.geo.redis.cache.windows.net", + "primaryHostName": "cache1.redis.cache.windows.net", + "provisioningState": "Succeeded", + "serverRole": "Secondary" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache3", + "name": "cache3", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache3", + "linkedRedisCacheLocation": "West US", + "geoReplicatedPrimaryHostName": "cache3.geo.redis.cache.windows.net", + "primaryHostName": "cache1.redis.cache.windows.net", + "provisioningState": "Succeeded", + "serverRole": "Secondary" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheList.json new file mode 100644 index 000000000000..62d8bdbb49f9 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "redisVersion": "3.2", + "sku": { + "name": "Standard", + "family": "C", + "capacity": 6 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": {}, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ] + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListByResourceGroup.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListByResourceGroup.json new file mode 100644 index 000000000000..4e9b60c845f6 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-04-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "redisVersion": "3.2", + "sku": { + "name": "Standard", + "family": "C", + "capacity": 6 + }, + "enableNonSslPort": true, + "redisConfiguration": {}, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380 + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListKeys.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListKeys.json new file mode 100644 index 000000000000..d93d0c615d3a --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListPrivateEndpointConnections.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListPrivateEndpointConnections.json new file mode 100644 index 000000000000..bd55391dcc41 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListPrivateEndpointConnections.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListPrivateLinkResources.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListPrivateLinkResources.json new file mode 100644 index 000000000000..fa47ca481cc4 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "rgtest01", + "cacheName": "cacheTest01", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cacheTest01/privateLinkResources/redisCache", + "name": "redisCache", + "type": "Microsoft.Cache/Redis/privateLinkResources", + "properties": { + "groupId": "redisCache", + "requiredMembers": [ + "redisCache" + ], + "requiredZoneNames": [ + "privatelink.redis.cache.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListUpgradeNotifications.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListUpgradeNotifications.json new file mode 100644 index 000000000000..38c9bb87a863 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheListUpgradeNotifications.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "history": "5000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "notification1", + "timestamp": "2017-02-16T23:20:50.52Z", + "upsellNotification": {} + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheOperations.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheOperations.json new file mode 100644 index 000000000000..6c3d1ad68aab --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheOperations.json @@ -0,0 +1,643 @@ +{ + "parameters": { + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cache/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability", + "description": "Checks if a name is available for use with a new Redis Cache" + } + }, + { + "name": "Microsoft.Cache/register/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Register Resource Provider Microsoft.Cache", + "description": "Registers the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/unregister/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Unregister Resource Provider Microsoft.Cache", + "description": "Unregisters the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/operations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "List Provider Operations", + "description": "Lists the operations that 'Microsoft.Cache' provider supports." + } + }, + { + "name": "Microsoft.Cache/locations/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read operation results", + "description": "Gets the result of a long running operation for which the 'Location' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/operationsStatus/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read the status of a long running operation", + "description": "View the status of a long running operation for which the 'AzureAsync' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/asyncOperations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read asynchronous operation status", + "description": "Read an Async Operation's Status" + } + }, + { + "name": "Microsoft.Cache/locations/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability in location", + "description": "Checks if a name is available for use with a new Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redis/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-write)", + "description": "Modify the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-only)", + "description": "View the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Delete Redis Cache", + "description": "Delete the entire Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "View Redis Cache Access Keys", + "description": "View the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Regenerate Redis Cache Access Keys", + "description": "Change the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Import data into Redis from storage", + "description": "Import data of a specified format from multiple blobs into Redis" + } + }, + { + "name": "Microsoft.Cache/redis/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Export Redis data to storage", + "description": "Export Redis data to prefixed storage blobs in specified format" + } + }, + { + "name": "Microsoft.Cache/redis/forceReboot/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Force reboot a cache instance, potentially with data loss.", + "description": "Force reboot a cache instance, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/stop/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Stop an Azure Cache for Redis, potentially with data loss.", + "description": "Stop an Azure Cache for Redis, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/start/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Start an Azure Cache for Redis", + "description": "Start an Azure Cache for Redis" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Delete Redis Enterprise cache", + "description": "Delete the entire Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (read)", + "description": "View the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (write)", + "description": "Modify the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Delete Redis Enterprise database", + "description": "Deletes a Redis Enterprise database and its contents" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (read)", + "description": "View the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (write)", + "description": "Modify the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Export Redis Enterprise database", + "description": "Export data to storage blobs from a Redis Enterprise database " + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/forceUnlink/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Force unlink Redis Enterprise database georeplica", + "description": "Forcibly unlink a georeplica Redis Enterprise database from its peers" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Import Redis Enterprise database", + "description": "Import data from storage blobs to a Redis Enterprise database" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "View Redis Enterprise database access keys", + "description": "View the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Regenerate Redis Enterprise database access keys", + "description": "Change the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise database operation results", + "operation": "View Redis Enterprise database operation results", + "description": "View the result of Redis Enterprise database operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise operation results", + "operation": "View Redis Enterprise operation results", + "description": "View the result of Redis Enterprise operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Cache", + "operation": "Read Redis Cache Metric Definitions", + "description": "Gets the available metrics for a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Enterprise Cache", + "operation": "Read Redis Enterprise Metric Definitions", + "description": "Gets the available metrics for a Redis Enterprise Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Get Redis Cache Patch Schedule", + "description": "Gets the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Change Redis Patching Schedule", + "description": "Modify the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Delete Redis Cache Patch Schedule", + "description": "Delete the patch schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Get Redis Cache Firewall Rule", + "description": "Get the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Update Redis Cache Firewall Rule", + "description": "Edit the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Delete Redis Cache Firewall Rule", + "description": "Delete IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Get Redis Cache Linked Servers", + "description": "Get Linked Servers associated with a redis cache." + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Add Redis Cache Linked Server", + "description": "Add Linked Server to a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Delete Redis Cache Linked Server", + "description": "Delete Linked Server from a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Get Redis Cache Event Grid Filter", + "description": "Get Redis Cache Event Grid Filter" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Update Redis Cache Event Grid Filters", + "description": "Update Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Delete Redis Cache Event Grid Filters", + "description": "Delete Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Redis Enterprise cache private endpoint operation results (read)", + "description": "View the result of private endpoint connection operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redis/roles/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Read Redis Roles", + "description": "Read roles on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Update Redis Roles", + "description": "Create or update role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Delete Redis Roles", + "description": "Delete role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Read Redis Role Assignments", + "description": "Read role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Update Redis Role Assignments", + "description": "Create or update role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Delete Redis Role Assignment", + "description": "Delete All Redis Role Assignments" + } + }, + { + "name": "Microsoft.Cache/redis/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json new file mode 100644 index 000000000000..af544e2ce90f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesCreateOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "default": "default", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cachename1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cachename1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesDelete.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesDelete.json new file mode 100644 index 000000000000..064e79b5ba5f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "default": "default", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesGet.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesGet.json new file mode 100644 index 000000000000..044940b6ecec --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "default": "default", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cache1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesList.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesList.json new file mode 100644 index 000000000000..1fe5e7b0e970 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePatchSchedulesList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cache1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePutPrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePutPrivateEndpointConnection.json new file mode 100644 index 000000000000..2474cf6f96fc --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCachePutPrivateEndpointConnection.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2023-04-01", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheRegenerateKey.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheRegenerateKey.json new file mode 100644 index 000000000000..ef90f7955a98 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheRegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheUpdate.json new file mode 100644 index 000000000000..e8c866eb4ad9 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/examples/RedisCacheUpdate.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-04-01", + "subscriptionId": "subid", + "parameters": { + "properties": { + "enableNonSslPort": true, + "replicasPerPrimary": 2 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "3.0", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "3.0", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ] + } + }, + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/redis.json new file mode 100644 index 000000000000..fd167cd8ea42 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/stable/2023-04-01/redis.json @@ -0,0 +1,2858 @@ +{ + "swagger": "2.0", + "info": { + "title": "RedisManagementClient", + "description": "REST API for Azure Redis Cache Service.", + "version": "2023-04-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.Cache/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available REST API operations of the Microsoft.Cache provider.", + "operationId": "Operations_List", + "x-ms-examples": { + "RedisCacheOperations": { + "$ref": "./examples/RedisCacheOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_CheckNameAvailability", + "x-ms-examples": { + "RedisCacheCheckNameAvailability": { + "$ref": "./examples/RedisCacheCheckNameAvailability.json" + } + }, + "description": "Checks that the redis cache name is valid and is not already in use.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + }, + "description": "Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis'" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Name is available" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/listUpgradeNotifications": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListUpgradeNotifications", + "x-ms-examples": { + "RedisCacheListUpgradeNotifications": { + "$ref": "./examples/RedisCacheListUpgradeNotifications.json" + } + }, + "description": "Gets any upgrade notifications for a Redis cache.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "history", + "in": "query", + "required": true, + "type": "number", + "format": "double", + "description": "how many minutes in past to look for upgrade notifications" + } + ], + "responses": { + "200": { + "description": "All upgrade notifications in given time range", + "schema": { + "$ref": "#/definitions/NotificationListResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}": { + "put": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Create", + "x-ms-examples": { + "RedisCacheCreateDefaultVersion": { + "$ref": "./examples/RedisCacheCreateDefaultVersion.json" + }, + "RedisCacheCreateLatestVersion": { + "$ref": "./examples/RedisCacheCreateLatestVersion.json" + }, + "RedisCacheCreate": { + "$ref": "./examples/RedisCacheCreate.json" + } + }, + "description": "Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisCreateParameters" + }, + "description": "Parameters supplied to the Create Redis operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new redis cache was successfully created. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "200": { + "description": "The existing redis cache was successfully updated. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Update", + "x-ms-examples": { + "RedisCacheUpdate": { + "$ref": "./examples/RedisCacheUpdate.json" + } + }, + "description": "Update an existing Redis cache.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisUpdateParameters" + }, + "description": "Parameters supplied to the Update Redis operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing redis cache was successfully updated. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "202": { + "description": "The existing redis cache was successfully updated. Check Azure-AsyncOperation headers to poll detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Delete", + "x-ms-examples": { + "RedisCacheDelete": { + "$ref": "./examples/RedisCacheDelete.json" + } + }, + "description": "Deletes a Redis cache.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The redis cache was successfully deleted." + }, + "202": { + "description": "The redis cache 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome." + }, + "204": { + "description": "The redis cache was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Get", + "x-ms-examples": { + "RedisCacheGet": { + "$ref": "./examples/RedisCacheGet.json" + } + }, + "description": "Gets a Redis cache (resource description).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The redis cache was successfully found.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListByResourceGroup", + "x-ms-examples": { + "RedisCacheListByResourceGroup": { + "$ref": "./examples/RedisCacheListByResourceGroup.json" + } + }, + "description": "Lists all Redis caches in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/RedisListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redis": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListBySubscription", + "x-ms-examples": { + "RedisCacheList": { + "$ref": "./examples/RedisCacheList.json" + } + }, + "description": "Gets all Redis caches in the specified subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/RedisListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/listKeys": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListKeys", + "x-ms-examples": { + "RedisCacheListKeys": { + "$ref": "./examples/RedisCacheListKeys.json" + } + }, + "description": "Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists the keys for the specified Redis cache.", + "schema": { + "$ref": "#/definitions/RedisAccessKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/regenerateKey": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_RegenerateKey", + "x-ms-examples": { + "RedisCacheRegenerateKey": { + "$ref": "./examples/RedisCacheRegenerateKey.json" + } + }, + "description": "Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisRegenerateKeyParameters" + }, + "description": "Specifies which key to regenerate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists the regenerated keys for Redis Cache", + "schema": { + "$ref": "#/definitions/RedisAccessKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/forceReboot": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ForceReboot", + "x-ms-examples": { + "RedisCacheForceReboot": { + "$ref": "./examples/RedisCacheForceReboot.json" + } + }, + "description": "Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisRebootParameters" + }, + "description": "Specifies which Redis node(s) to reboot." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Reboot operation successfully enqueued", + "schema": { + "$ref": "#/definitions/RedisForceRebootResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/import": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ImportData", + "x-ms-examples": { + "RedisCacheImport": { + "$ref": "./examples/RedisCacheImport.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Import data into Redis cache.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportRDBParameters" + }, + "description": "Parameters for Redis import operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Import operation successfully enqueued; follow the Location header to poll for final outcome." + }, + "200": { + "description": "Import operation succeeded." + }, + "204": { + "description": "Import operation succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/export": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ExportData", + "x-ms-examples": { + "RedisCacheExport": { + "$ref": "./examples/RedisCacheExport.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Export data from the redis cache to blobs in a container.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExportRDBParameters" + }, + "description": "Parameters for Redis export operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Export operation successfully enqueued; follow the Location header to poll for final outcome." + }, + "200": { + "description": "Export operation succeeded." + }, + "204": { + "description": "Export operation succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules": { + "get": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_List", + "description": "Gets all firewall rules in the specified redis cache.", + "x-ms-examples": { + "RedisCacheFirewallRulesList": { + "$ref": "./examples/RedisCacheFirewallRulesList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + } + ], + "responses": { + "200": { + "description": "Successfully got the current rules", + "schema": { + "$ref": "#/definitions/RedisFirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}": { + "put": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "description": "Create or update a redis cache firewall rule", + "x-ms-examples": { + "RedisCacheFirewallRuleCreate": { + "$ref": "./examples/RedisCacheFirewallRuleCreate.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + }, + "description": "Parameters supplied to the create or update redis firewall rule operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Resource was successfully updated", + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + } + }, + "201": { + "description": "Resource was successfully created", + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "description": "Gets a single firewall rule in a specified redis cache.", + "x-ms-examples": { + "RedisCacheFirewallRuleGet": { + "$ref": "./examples/RedisCacheFirewallRuleGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully found the rule", + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "description": "Deletes a single firewall rule in a specified redis cache.", + "x-ms-examples": { + "RedisCacheFirewallRuleDelete": { + "$ref": "./examples/RedisCacheFirewallRuleDelete.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the rule" + }, + "204": { + "description": "Successfully deleted the rule" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/patchSchedules": { + "get": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_ListByRedisResource", + "description": "Gets all patch schedules in the specified redis cache (there is only one).", + "x-ms-examples": { + "RedisCachePatchSchedulesList": { + "$ref": "./examples/RedisCachePatchSchedulesList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + } + ], + "responses": { + "200": { + "description": "Successfully got the current patch schedules", + "schema": { + "$ref": "#/definitions/RedisPatchScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}": { + "put": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_CreateOrUpdate", + "x-ms-examples": { + "RedisCachePatchSchedulesCreateOrUpdate": { + "$ref": "./examples/RedisCachePatchSchedulesCreateOrUpdate.json" + } + }, + "description": "Create or replace the patching schedule for Redis cache.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "default", + "in": "path", + "required": true, + "type": "string", + "description": "Default string modeled as parameter for auto generation to work correctly.", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "defaultName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + }, + "description": "Parameters to set the patching schedule for Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The patch schedule was successfully updated.", + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + } + }, + "201": { + "description": "The patch schedule was successfully created.", + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_Delete", + "x-ms-examples": { + "RedisCachePatchSchedulesDelete": { + "$ref": "./examples/RedisCachePatchSchedulesDelete.json" + } + }, + "description": "Deletes the patching schedule of a redis cache.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "default", + "in": "path", + "required": true, + "type": "string", + "description": "Default string modeled as parameter for auto generation to work correctly.", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "defaultName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "204": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_Get", + "x-ms-examples": { + "RedisCachePatchSchedulesGet": { + "$ref": "./examples/RedisCachePatchSchedulesGet.json" + } + }, + "description": "Gets the patching schedule of a redis cache.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "default", + "in": "path", + "required": true, + "type": "string", + "description": "Default string modeled as parameter for auto generation to work correctly.", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "defaultName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get patch schedules.", + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}": { + "put": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_Create", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LinkedServer_Create": { + "$ref": "./examples/RedisCacheLinkedServer_Create.json" + } + }, + "description": "Adds a linked server to the Redis cache (requires Premium SKU).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "linkedServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the linked server that is being added to the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisLinkedServerCreateParameters" + }, + "description": "Parameters supplied to the Create Linked server operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The linked server was successfully added.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + } + }, + "201": { + "description": "The linked server was successfully added.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_Delete", + "x-ms-examples": { + "LinkedServerDelete": { + "$ref": "./examples/RedisCacheLinkedServer_Delete.json" + } + }, + "description": "Deletes the linked server from a redis cache (requires Premium SKU).", + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "linkedServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the linked server that is being added to the Redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Linked server was successfully deleted." + }, + "202": { + "description": "The linked server 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_Get", + "x-ms-examples": { + "LinkedServer_Get": { + "$ref": "./examples/RedisCacheLinkedServer_Get.json" + } + }, + "description": "Gets the detailed information about a linked server of a redis cache (requires Premium SKU).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "linkedServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the linked server." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get linked server.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_List", + "x-ms-examples": { + "LinkedServer_List": { + "$ref": "./examples/RedisCacheLinkedServer_List.json" + } + }, + "description": "Gets the list of linked servers associated with this redis cache (requires Premium SKU).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get linked servers.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithPropertiesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "List all the private endpoint connections associated with the redis cache.", + "x-ms-examples": { + "RedisCacheListPrivateEndpointConnection": { + "$ref": "./examples/RedisCacheListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the redis cache.", + "x-ms-examples": { + "RedisCacheGetPrivateEndpointConnection": { + "$ref": "./examples/RedisCacheGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Put", + "description": "Update the state of specified private endpoint connection associated with the redis cache.", + "x-ms-examples": { + "RedisCachePutPrivateEndpointConnection": { + "$ref": "./examples/RedisCachePutPrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the redis cache.", + "x-ms-examples": { + "RedisCacheDeletePrivateEndpointConnection": { + "$ref": "./examples/RedisCacheDeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "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/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByRedisCache", + "description": "Gets the private link resources that need to be created for a redis cache.", + "x-ms-examples": { + "StorageAccountListPrivateLinkResources": { + "$ref": "./examples/RedisCacheListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/asyncOperations/{operationId}": { + "get": { + "tags": [ + "AsyncOperationStatus" + ], + "operationId": "AsyncOperationStatus_Get", + "description": "For checking the ongoing status of an operation", + "x-ms-examples": { + "RedisCacheAsyncOperationStatus": { + "$ref": "./examples/RedisCacheAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location at which operation was triggered" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of asynchronous operation" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Asynchronous operation status response", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "family": { + "type": "string", + "description": "The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).", + "enum": [ + "C", + "P" + ], + "x-ms-enum": { + "name": "SkuFamily", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4)." + } + }, + "required": [ + "name", + "family", + "capacity" + ], + "description": "SKU parameters supplied to the create Redis operation." + }, + "RedisCommonProperties": { + "properties": { + "redisConfiguration": { + "type": "object", + "properties": { + "rdb-backup-enabled": { + "type": "string", + "description": "Specifies whether the rdb backup is enabled" + }, + "rdb-backup-frequency": { + "type": "string", + "description": "Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440)" + }, + "rdb-backup-max-snapshot-count": { + "type": "string", + "description": "Specifies the maximum number of snapshots for rdb backup" + }, + "rdb-storage-connection-string": { + "type": "string", + "description": "The storage account connection string for storing rdb file" + }, + "aof-backup-enabled": { + "type": "string", + "description": "Specifies whether the aof backup is enabled" + }, + "aof-storage-connection-string-0": { + "type": "string", + "description": "First storage account connection string" + }, + "aof-storage-connection-string-1": { + "type": "string", + "description": "Second storage account connection string" + }, + "maxfragmentationmemory-reserved": { + "type": "string", + "description": "Value in megabytes reserved for fragmentation per shard" + }, + "maxmemory-policy": { + "type": "string", + "description": "The eviction strategy used when your data won't fit within its memory limit." + }, + "maxmemory-reserved": { + "type": "string", + "description": "Value in megabytes reserved for non-cache usage per shard e.g. failover." + }, + "maxmemory-delta": { + "type": "string", + "description": "Value in megabytes reserved for non-cache usage per shard e.g. failover." + }, + "maxclients": { + "type": "string", + "description": "The max clients config", + "readOnly": true + }, + "preferred-data-archive-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS", + "readOnly": true + }, + "preferred-data-persistence-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS" + }, + "zonal-configuration": { + "type": "string", + "description": "Zonal Configuration", + "readOnly": true + }, + "authnotrequired": { + "type": "string", + "description": "Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view." + }, + "storage-subscription-id": { + "type": "string", + "description": "SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity." + } + }, + "additionalProperties": {}, + "description": "All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc." + }, + "redisVersion": { + "type": "string", + "description": "Redis version. This should be in the form 'major[.minor]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is 'latest'." + }, + "enableNonSslPort": { + "type": "boolean", + "default": false, + "description": "Specifies whether the non-ssl Redis server port (6379) is enabled." + }, + "replicasPerMaster": { + "type": "integer", + "format": "int32", + "description": "The number of replicas to be created per primary." + }, + "replicasPerPrimary": { + "type": "integer", + "format": "int32", + "description": "The number of replicas to be created per primary." + }, + "tenantSettings": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of tenant settings" + }, + "shardCount": { + "type": "integer", + "format": "int32", + "description": "The number of shards to be created on a Premium Cluster Cache." + }, + "minimumTlsVersion": { + "type": "string", + "description": "Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')", + "enum": [ + "1.0", + "1.1", + "1.2" + ], + "x-ms-enum": { + "name": "TlsVersion", + "modelAsString": true + } + }, + "publicNetworkAccess": { + "description": "Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + } + }, + "description": "Create/Update/Get common properties of the redis cache.", + "x-ms-external": true + }, + "RedisCreateProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the Redis cache to deploy." + }, + "subnetId": { + "type": "string", + "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", + "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" + }, + "staticIP": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+\\.\\d+$", + "description": "Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/RedisCommonProperties" + } + ], + "description": "Properties supplied to Create Redis operation.", + "x-ms-external": true + }, + "RedisUpdateProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the Redis cache to deploy." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RedisCommonProperties" + } + ], + "description": "Patchable properties of the redis cache.", + "x-ms-external": true + }, + "RedisProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Redis instance provisioning status.", + "enum": [ + "Creating", + "Deleting", + "Disabled", + "Failed", + "Linking", + "Provisioning", + "RecoveringScaleFailure", + "Scaling", + "Succeeded", + "Unlinking", + "Unprovisioning", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "hostName": { + "readOnly": true, + "type": "string", + "description": "Redis host name." + }, + "port": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Redis non-SSL port." + }, + "sslPort": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Redis SSL port." + }, + "accessKeys": { + "readOnly": true, + "$ref": "#/definitions/RedisAccessKeys", + "description": "The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache" + }, + "linkedServers": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RedisLinkedServer" + }, + "description": "List of the linked servers associated with the cache" + }, + "instances": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RedisInstanceDetails" + }, + "x-ms-identifiers": [ + "shardId" + ], + "description": "List of the Redis instances associated with the cache" + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified redis cache" + } + }, + "allOf": [ + { + "$ref": "#/definitions/RedisCreateProperties" + } + ], + "description": "Properties of the redis cache.", + "x-ms-external": true + }, + "RedisCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisCreateProperties", + "description": "Redis cache properties." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + } + }, + "required": [ + "properties", + "location" + ], + "description": "Parameters supplied to the Create Redis operation." + }, + "RedisUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisUpdateProperties", + "description": "Redis cache properties." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + } + }, + "description": "Parameters supplied to the Update Redis operation." + }, + "RedisAccessKeys": { + "properties": { + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "The current primary key that clients can use to authenticate with Redis cache." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "The current secondary key that clients can use to authenticate with Redis cache." + } + }, + "description": "Redis cache access keys." + }, + "RedisFirewallRule": { + "description": "A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisFirewallRuleProperties", + "description": "redis cache firewall rule properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RedisFirewallRuleCreateParameters": { + "allOf": [ + { + "$ref": "#/definitions/RedisFirewallRule" + } + ], + "description": "Parameters required for creating a firewall rule on redis cache. (Note, you can just use the FirewallRule type instead now.)" + }, + "RedisFirewallRuleProperties": { + "description": "Specifies a range of IP addresses permitted to connect to the cache", + "properties": { + "startIP": { + "type": "string", + "description": "lowest IP address included in the range" + }, + "endIP": { + "type": "string", + "description": "highest IP address included in the range" + } + }, + "required": [ + "startIP", + "endIP" + ] + }, + "RedisFirewallRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisFirewallRule" + }, + "description": "Results of the list firewall rules operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list firewall rules Redis operation." + }, + "RedisResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisProperties", + "description": "Redis cache properties." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "A single Redis item in List or Get Operation." + }, + "RedisInstanceDetails": { + "properties": { + "sslPort": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Redis instance SSL port." + }, + "nonSslPort": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "If enableNonSslPort is true, provides Redis instance Non-SSL port." + }, + "zone": { + "readOnly": true, + "type": "string", + "description": "If the Cache uses availability zones, specifies availability zone where this instance is located." + }, + "shardId": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "If clustering is enabled, the Shard ID of Redis Instance" + }, + "isMaster": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the instance is a primary node." + }, + "isPrimary": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the instance is a primary node." + } + }, + "description": "Details of single instance of redis." + }, + "RedisListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisResource" + }, + "description": "List of Redis cache instances." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list Redis operation." + }, + "RedisRegenerateKeyParameters": { + "properties": { + "keyType": { + "type": "string", + "description": "The Redis access key to regenerate.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "RedisKeyType", + "modelAsString": false + } + } + }, + "required": [ + "keyType" + ], + "description": "Specifies which Redis access keys to reset." + }, + "RedisRebootParameters": { + "properties": { + "rebootType": { + "type": "string", + "description": "Which Redis node(s) to reboot. Depending on this value data loss is possible.", + "enum": [ + "PrimaryNode", + "SecondaryNode", + "AllNodes" + ], + "x-ms-enum": { + "name": "RebootType", + "modelAsString": true + } + }, + "shardId": { + "type": "integer", + "format": "int32", + "description": "If clustering is enabled, the ID of the shard to be rebooted." + }, + "ports": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "A list of redis instances to reboot, specified by per-instance SSL ports or non-SSL ports." + } + }, + "description": "Specifies which Redis node(s) to reboot." + }, + "ExportRDBParameters": { + "properties": { + "format": { + "type": "string", + "description": "File format." + }, + "prefix": { + "type": "string", + "description": "Prefix to use for exported files." + }, + "container": { + "type": "string", + "description": "Container name to export to." + }, + "preferred-data-archive-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS" + }, + "storage-subscription-id": { + "type": "string", + "description": "Subscription id of the storage container for data to be exported using ManagedIdentity." + } + }, + "required": [ + "container", + "prefix" + ], + "description": "Parameters for Redis export operation." + }, + "ImportRDBParameters": { + "properties": { + "format": { + "type": "string", + "description": "File format." + }, + "files": { + "type": "array", + "description": "files to import.", + "items": { + "type": "string" + } + }, + "preferred-data-archive-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS" + }, + "storage-subscription-id": { + "type": "string", + "description": "Subscription id of the storage container containing files to import using Managed Identity." + } + }, + "required": [ + "files" + ], + "description": "Parameters for Redis import operation." + }, + "ScheduleEntry": { + "properties": { + "dayOfWeek": { + "type": "string", + "description": "Day of the week when a cache can be patched.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday", + "Everyday", + "Weekend" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "startHourUtc": { + "type": "integer", + "format": "int32", + "description": "Start hour after which cache patching can start." + }, + "maintenanceWindow": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying how much time cache patching can take. " + } + }, + "required": [ + "dayOfWeek", + "startHourUtc" + ], + "description": "Patch schedule entry for a Premium Redis Cache." + }, + "ScheduleEntries": { + "properties": { + "scheduleEntries": { + "x-ms-client-name": "ScheduleEntries", + "type": "array", + "items": { + "$ref": "#/definitions/ScheduleEntry" + }, + "x-ms-identifiers": [], + "description": "List of patch schedules for a Redis cache." + } + }, + "required": [ + "scheduleEntries" + ], + "description": "List of patch schedules for a Redis cache." + }, + "RedisPatchSchedule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleEntries", + "description": "List of patch schedules for a Redis cache." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives", + "readOnly": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Response to put/get patch schedules for Redis cache." + }, + "RedisPatchScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisPatchSchedule" + }, + "description": "Results of the list patch schedules operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list patch schedules Redis operation." + }, + "RedisForceRebootResponse": { + "properties": { + "message": { + "readOnly": true, + "type": "string", + "description": "Status message" + } + }, + "description": "Response to force reboot for Redis cache." + }, + "RedisLinkedServer": { + "description": "Linked server Id", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Linked server Id." + } + } + }, + "RedisLinkedServerWithProperties": { + "description": "Response to put/get linked server (with properties) for Redis cache.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisLinkedServerProperties", + "description": "Properties of the linked server." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RedisLinkedServerProperties": { + "description": "Properties of a linked server to be returned in get/put response", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Terminal state of the link between primary and secondary redis cache." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RedisLinkedServerCreateProperties" + } + ] + }, + "RedisLinkedServerWithPropertiesList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + }, + "description": "List of linked servers (with properties) of a Redis cache." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next set." + } + }, + "description": "List of linked servers (with properties) of a Redis cache." + }, + "RedisLinkedServerCreateProperties": { + "description": "Create properties for a linked server", + "properties": { + "linkedRedisCacheId": { + "type": "string", + "description": "Fully qualified resourceId of the linked redis cache." + }, + "linkedRedisCacheLocation": { + "type": "string", + "description": "Location of the linked redis cache.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serverRole": { + "type": "string", + "description": "Role of the linked server.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "ReplicationRole", + "modelAsString": false + } + }, + "geoReplicatedPrimaryHostName": { + "type": "string", + "readOnly": true, + "description": "The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience." + }, + "primaryHostName": { + "type": "string", + "readOnly": true, + "description": "The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover." + } + }, + "required": [ + "linkedRedisCacheId", + "linkedRedisCacheLocation", + "serverRole" + ] + }, + "RedisLinkedServerCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisLinkedServerCreateProperties", + "description": "Properties required to create a linked server." + } + }, + "required": [ + "properties" + ], + "description": "Parameter required for creating a linked server to redis cache." + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that describes the operation.", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete, listKeys/action, etc.", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "description": "Friendly name of the operation", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "CheckNameAvailabilityParameters": { + "description": "Parameters body to pass for resource name availability check.", + "properties": { + "name": { + "type": "string", + "description": "Resource name." + }, + "type": { + "type": "string", + "description": "Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'." + } + }, + "required": [ + "name", + "type" + ] + }, + "UpgradeNotification": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of upgrade notification." + }, + "timestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Timestamp when upgrade notification occurred." + }, + "upsellNotification": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Details about this upgrade notification" + } + }, + "description": "Properties of upgrade notification." + }, + "NotificationListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UpgradeNotification" + }, + "x-ms-identifiers": [ + "name", + "timestamp" + ], + "description": "List of all notifications." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next set of notifications." + } + }, + "description": "The response of listUpgradeNotifications." + }, + "OperationStatus": { + "type": "object", + "description": "Asynchronous operation status", + "properties": { + "properties": { + "description": "Additional properties from RP, only when operation is successful", + "type": "object", + "additionalProperties": {} + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult" + } + ] + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/redis/resource-manager/readme.md b/specification/redis/resource-manager/readme.md index c889f58b752b..c55685751c6c 100644 --- a/specification/redis/resource-manager/readme.md +++ b/specification/redis/resource-manager/readme.md @@ -26,18 +26,27 @@ These are the global settings for the Redis API. ``` yaml openapi-type: arm -tag: package-2022-06 +tag: package-2023-04 ``` +### Tag: package-2023-04 + +These settings apply only when `--tag=package-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-2023-04' +input-file: + - Microsoft.Cache/stable/2023-04-01/redis.json +``` ### Tag: package-2022-06 These settings apply only when `--tag=package-2022-06` is specified on the command line. -```yaml $(tag) == 'package-2022-06' +``` yaml $(tag) == 'package-2022-06' input-file: - Microsoft.Cache/stable/2022-06-01/redis.json ``` + ### Tag: package-2022-05 These settings apply only when `--tag=package-2022-05` is specified on the command line. From 1c4b161f7e259669789340da018051084209e3fe Mon Sep 17 00:00:00 2001 From: prampMSFT <115494586+prampMSFT@users.noreply.github.com> Date: Fri, 5 May 2023 09:00:49 +0530 Subject: [PATCH 25/79] Update AppServicePlans.json (#23776) Updating the Description for the App Service Plans - Reboot Worker API. With VMSS stamps being utilized for App Services, the worker names need not necessarily have to start with RD. They can start with RD, dw, pd, xn, lw, pl, hr, aw, al etc. Due to multiple variations, making changes to the description. --- .../Microsoft.Web/stable/2022-03-01/AppServicePlans.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/AppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/AppServicePlans.json index 2d72f56d8187..c96a034cbfdf 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/AppServicePlans.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2022-03-01/AppServicePlans.json @@ -1432,7 +1432,7 @@ { "name": "workerName", "in": "path", - "description": "Name of worker machine, which typically starts with RD.", + "description": "Name of worker machine.", "required": true, "type": "string" }, From b2fe1573f29f056930d79b1b8abf2611b98fa81a Mon Sep 17 00:00:00 2001 From: Yuchao Yan Date: Fri, 5 May 2023 13:59:50 +0800 Subject: [PATCH 26/79] Update readme.python.md (#23827) --- .../paloaltonetworks/resource-manager/readme.python.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/paloaltonetworks/resource-manager/readme.python.md b/specification/paloaltonetworks/resource-manager/readme.python.md index b2ff77849aa7..c0bb83e6fa3e 100644 --- a/specification/paloaltonetworks/resource-manager/readme.python.md +++ b/specification/paloaltonetworks/resource-manager/readme.python.md @@ -7,8 +7,8 @@ Please also specify `--python-sdks-folder= Date: Fri, 5 May 2023 12:42:39 +0530 Subject: [PATCH 27/79] [Hub Generated] Review request for Microsoft.Cache to add version preview/2023-05-01-preview (#23745) * Adds base for updating Microsoft.Cache from version stable/2022-06-01 to version 2023-05-01-preview * Updates readme * Updates API version in new specs and examples * Take base changes from approved release branch 2023-05-01 preview * Update api version label to 2023-05-01-preview * Address PR suggestions from release branch * Spec validation correction * Add min max length for access policy and access policy assignment * Remove breaking changes * Remove body from delete 202 response * Add add x-ms-parameter-location method * Update redis readme --------- Co-authored-by: Kanchan Joshi --- ...cheAccessPolicyAssignmentCreateUpdate.json | 44 + ...edisCacheAccessPolicyAssignmentDelete.json | 18 + .../RedisCacheAccessPolicyAssignmentGet.json | 24 + .../RedisCacheAccessPolicyAssignmentList.json | 38 + .../RedisCacheAccessPolicyCreateUpdate.json | 40 + .../RedisCacheAccessPolicyDelete.json | 18 + .../examples/RedisCacheAccessPolicyGet.json | 23 + .../examples/RedisCacheAccessPolicyList.json | 36 + .../RedisCacheAsyncOperationStatus.json | 22 + .../RedisCacheCheckNameAvailability.json | 13 + .../examples/RedisCacheCreate.json | 205 + .../RedisCacheCreateDefaultVersion.json | 204 + .../RedisCacheCreateLatestVersion.json | 205 + .../examples/RedisCacheDelete.json | 17 + ...sCacheDeletePrivateEndpointConnection.json | 13 + .../examples/RedisCacheExport.json | 22 + .../RedisCacheFirewallRuleCreate.json | 39 + .../RedisCacheFirewallRuleDelete.json | 13 + .../examples/RedisCacheFirewallRuleGet.json | 22 + .../examples/RedisCacheFirewallRulesList.json | 34 + .../examples/RedisCacheForceReboot.json | 23 + .../examples/RedisCacheGet.json | 76 + ...edisCacheGetPrivateEndpointConnection.json | 29 + .../examples/RedisCacheImport.json | 23 + .../RedisCacheLinkedServer_Create.json | 48 + .../RedisCacheLinkedServer_Delete.json | 17 + .../examples/RedisCacheLinkedServer_Get.json | 26 + .../examples/RedisCacheLinkedServer_List.json | 42 + .../examples/RedisCacheList.json | 57 + .../RedisCacheListByResourceGroup.json | 36 + .../examples/RedisCacheListKeys.json | 16 + ...isCacheListPrivateEndpointConnections.json | 49 + .../RedisCacheListPrivateLinkResources.json | 30 + .../RedisCacheListUpgradeNotifications.json | 22 + .../examples/RedisCacheOperations.json | 643 ++++ ...edisCachePatchSchedulesCreateOrUpdate.json | 68 + .../RedisCachePatchSchedulesDelete.json | 13 + .../examples/RedisCachePatchSchedulesGet.json | 32 + .../RedisCachePatchSchedulesList.json | 35 + ...edisCachePutPrivateEndpointConnection.json | 55 + .../examples/RedisCacheRegenerateKey.json | 19 + .../examples/RedisCacheUpdate.json | 125 + .../preview/2023-05-01-preview/redis.json | 3288 +++++++++++++++++ .../redis/resource-manager/readme.md | 9 + 44 files changed, 5831 insertions(+) create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentCreateUpdate.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentDelete.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentGet.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentList.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyCreateUpdate.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyDelete.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyGet.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyList.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAsyncOperationStatus.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCheckNameAvailability.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreate.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreateDefaultVersion.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreateLatestVersion.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheDelete.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheDeletePrivateEndpointConnection.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheExport.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleCreate.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleDelete.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleGet.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRulesList.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheForceReboot.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheGet.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheGetPrivateEndpointConnection.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheImport.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Create.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Delete.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Get.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_List.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheList.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListByResourceGroup.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListKeys.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListPrivateEndpointConnections.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListPrivateLinkResources.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListUpgradeNotifications.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheOperations.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesCreateOrUpdate.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesDelete.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesGet.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesList.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePutPrivateEndpointConnection.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheRegenerateKey.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheUpdate.json create mode 100644 specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/redis.json diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentCreateUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentCreateUpdate.json new file mode 100644 index 000000000000..b3d3d6c48380 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentCreateUpdate.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cacheName": "cache1", + "accessPolicyAssignmentName": "accessPolicyAssignmentName1", + "api-version": "2023-05-01-preview", + "parameters": { + "properties": { + "accessPolicyName": "accessPolicy1", + "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0", + "objectIdAlias": "TestAADAppRedis" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/accessPolicyAssignments/accessPolicyAssignmentName1", + "name": "accessPolicyAssignmentName1", + "type": "Microsoft.Cache/Redis/accessPolicyAssignments", + "properties": { + "provisioningState": "Succeeded", + "accessPolicyName": "accessPolicy1", + "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0", + "objectIdAlias": "TestAADAppRedis" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/accessPolicyAssignments/accessPolicyAssignmentName1", + "name": "accessPolicyAssignmentName1", + "type": "Microsoft.Cache/Redis/accessPolicyAssignments", + "properties": { + "provisioningState": "Succeeded", + "accessPolicyName": "accessPolicy1", + "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0", + "objectIdAlias": "TestAADAppRedis" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentDelete.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentDelete.json new file mode 100644 index 000000000000..3505efeab419 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cacheName": "cache1", + "accessPolicyAssignmentName": "accessPolicyAssignmentName1", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentGet.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentGet.json new file mode 100644 index 000000000000..bbb07cc8c92a --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cacheName": "cache1", + "accessPolicyAssignmentName": "accessPolicyAssignmentName1", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/accessPolicyAssignments/accessPolicyAssignmentName1", + "name": "accessPolicyAssignmentName1", + "type": "Microsoft.Cache/Redis/accessPolicyAssignments", + "properties": { + "provisioningState": "Succeeded", + "accessPolicyName": "accessPolicy1", + "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0", + "objectIdAlias": "TestAADAppRedis" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentList.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentList.json new file mode 100644 index 000000000000..bc2eab177921 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyAssignmentList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cacheName": "cache1", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/accessPolicyAssignments/accessPolicyAssignmentName1", + "name": "accessPolicyAssignmentName1", + "type": "Microsoft.Cache/Redis/accessPolicyAssignments", + "properties": { + "provisioningState": "Succeeded", + "accessPolicyName": "accessPolicy1", + "objectId": "6497c918-11ad-41e7-1b0f-7c518a87d0b0", + "objectIdAlias": "TestAADAppRedis1" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/redis/cache1/accessPolicyAssignments/accessPolicyAssignmentName2", + "name": "accessPolicyAssignmentName2", + "type": "Microsoft.Cache/Redis/accessPolicyAssignments", + "properties": { + "provisioningState": "Succeeded", + "accessPolicyName": "accessPolicy2", + "objectId": "7497c918-11ad-41e7-1b0f-7c518a87d0b0", + "objectIdAlias": "TestAADAppRedis2" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyCreateUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyCreateUpdate.json new file mode 100644 index 000000000000..d604712554e1 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyCreateUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cacheName": "cache1", + "accessPolicyName": "accessPolicy1", + "api-version": "2023-05-01-preview", + "parameters": { + "properties": { + "permissions": "+get +hget" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/accessPolicies/accessPolicy1", + "name": "accessPolicy1", + "type": "Microsoft.Cache/Redis/accessPolicies", + "properties": { + "provisioningState": "Succeeded", + "permissions": "+get +hget", + "type": "Custom" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/accessPolicies/accessPolicy1", + "name": "accessPolicy1", + "type": "Microsoft.Cache/Redis/accessPolicies", + "properties": { + "provisioningState": "Succeeded", + "permissions": "+get +hget", + "type": "Custom" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyDelete.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyDelete.json new file mode 100644 index 000000000000..a576ebea9d5a --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyDelete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cacheName": "cache1", + "accessPolicyName": "accessPolicy1", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyGet.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyGet.json new file mode 100644 index 000000000000..0cb8b87f8a3f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cacheName": "cache1", + "accessPolicyName": "accessPolicy1", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/accessPolicies/accessPolicy1", + "name": "accessPolicy1", + "type": "Microsoft.Cache/Redis/accessPolicies", + "properties": { + "provisioningState": "Succeeded", + "permissions": "+get +hget", + "type": "Custom" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyList.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyList.json new file mode 100644 index 000000000000..31fcce2d973f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAccessPolicyList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "cacheName": "cache1", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/accessPolicies/accessPolicyBuiltIn", + "name": "accessPolicyBuiltIn", + "type": "Microsoft.Cache/Redis/accessPolicies", + "properties": { + "provisioningState": "Succeeded", + "permissions": "+get +hget", + "type": "BuiltIn" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/accessPolicies/accessPolicy1", + "name": "accessPolicy1", + "type": "Microsoft.Cache/Redis/accessPolicies", + "properties": { + "provisioningState": "Succeeded", + "permissions": "+get +hget", + "type": "Custom" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAsyncOperationStatus.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAsyncOperationStatus.json new file mode 100644 index 000000000000..5802eaa75495 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheAsyncOperationStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "location": "East US", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "operationId": "c7ba2bf5-5939-4d79-b037-2964ccf097da" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Cache/locations/East US/asyncOperations/c7ba2bf5-5939-4d79-b037-2964ccf097da", + "name": "c7ba2bf5-5939-4d79-b037-2964ccf097da", + "status": "Succeeded", + "startTime": null, + "endTime": null, + "percentComplete": null, + "properties": null, + "error": null + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCheckNameAvailability.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCheckNameAvailability.json new file mode 100644 index 000000000000..91945dcb963b --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCheckNameAvailability.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "type": "Microsoft.Cache/Redis", + "name": "cacheName" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreate.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreate.json new file mode 100644 index 000000000000..264e79c5407c --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreate.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "zones": [ + "1" + ], + "properties": { + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "redisVersion": "4", + "enableNonSslPort": true, + "shardCount": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "subnetId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1", + "staticIP": "192.168.0.5", + "minimumTlsVersion": "1.2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "4.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "4.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreateDefaultVersion.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreateDefaultVersion.json new file mode 100644 index 000000000000..ef97b6eaf4c2 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreateDefaultVersion.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "zones": [ + "1" + ], + "properties": { + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": true, + "shardCount": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "subnetId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1", + "staticIP": "192.168.0.5", + "minimumTlsVersion": "1.2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreateLatestVersion.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreateLatestVersion.json new file mode 100644 index 000000000000..9f78fefeb513 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheCreateLatestVersion.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "location": "West US", + "zones": [ + "1" + ], + "properties": { + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "redisVersion": "Latest", + "enableNonSslPort": true, + "shardCount": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "subnetId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/network1/subnets/subnet1", + "staticIP": "192.168.0.5", + "minimumTlsVersion": "1.2" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxmemory-policy": "allkeys-lru" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "zones": [ + "1" + ], + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "6.0.14", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": false, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "minimumTlsVersion": "1.2", + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "zone": "1", + "shardId": 0, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "zone": "1", + "shardId": 0, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15003, + "nonSslPort": 13003, + "zone": "1", + "shardId": 1, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15004, + "nonSslPort": 13004, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15005, + "nonSslPort": 13005, + "zone": "1", + "shardId": 1, + "isMaster": false, + "isPrimary": false + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheDelete.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheDelete.json new file mode 100644 index 000000000000..6f8424423b28 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheDeletePrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..a4bb6206fa3d --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheDeletePrivateEndpointConnection.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheExport.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheExport.json new file mode 100644 index 000000000000..aa8b96f814e1 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheExport.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "format": "RDB", + "prefix": "datadump1", + "container": "https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters" + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleCreate.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleCreate.json new file mode 100644 index 000000000000..08faa6d074a7 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleCreate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "ruleName": "rule1", + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "cache1/rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "cache1/rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleDelete.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleDelete.json new file mode 100644 index 000000000000..8f32862665d5 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "ruleName": "rule1", + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleGet.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleGet.json new file mode 100644 index 000000000000..6c0ebe1af5f3 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRuleGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "ruleName": "rule1", + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "cache1/rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRulesList.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRulesList.json new file mode 100644 index 000000000000..656f1614730b --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheFirewallRulesList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule1", + "name": "rule1", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.168.1.1", + "endIP": "192.168.1.4" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/firewallRules/rule2", + "name": "rule2", + "type": "Microsoft.Cache/Redis/firewallRules", + "properties": { + "startIP": "192.169.1.0", + "endIP": "192.169.1.255" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheForceReboot.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheForceReboot.json new file mode 100644 index 000000000000..1075b5b011b5 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheForceReboot.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "shardId": 0, + "rebootType": "AllNodes", + "ports": [ + 13000, + 15001 + ] + } + }, + "responses": { + "200": { + "body": { + "message": "reboot operation enqueued" + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheGet.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheGet.json new file mode 100644 index 000000000000..f66ecce7cc68 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheGet.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "redisVersion": "3.2", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 3 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": {}, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "linkedServers": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2" + } + ], + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ], + "publicNetworkAccess": "Enabled", + "privateEndpointConnections": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/privateEndpointConnections/cachePec", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/cachePe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Please approve my connection", + "actionsRequired": "None" + } + } + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheGetPrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..afc55b9d5b0f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheGetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheImport.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheImport.json new file mode 100644 index 000000000000..474dfbfba9db --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheImport.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "format": "RDB", + "files": [ + "http://fileuris.contoso.com/pathtofile1" + ] + } + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + }, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Create.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Create.json new file mode 100644 index 000000000000..91a8e206e7e7 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Create.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "linkedServerName": "cache2", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "serverRole": "Secondary" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "geoReplicatedPrimaryHostName": "cache2.geo.redis.cache.windows.net", + "primaryHostName": "cache1.redis.cache.windows.net", + "provisioningState": "Creating", + "serverRole": "Secondary" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "geoReplicatedPrimaryHostName": "cache2.geo.redis.cache.windows.net", + "primaryHostName": "cache1.redis.cache.windows.net", + "provisioningState": "Creating", + "serverRole": "Secondary" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Delete.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Delete.json new file mode 100644 index 000000000000..a19f0cd38ca5 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "linkedServerName": "cache2", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Get.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Get.json new file mode 100644 index 000000000000..4aa844eaaebd --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "linkedServerName": "cache2" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "geoReplicatedPrimaryHostName": "cache2.geo.redis.cache.windows.net", + "primaryHostName": "cache1.redis.cache.windows.net", + "provisioningState": "Succeeded", + "serverRole": "Secondary" + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_List.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_List.json new file mode 100644 index 000000000000..dff198a4de07 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheLinkedServer_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache2", + "name": "cache2", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache2", + "linkedRedisCacheLocation": "West US", + "geoReplicatedPrimaryHostName": "cache2.geo.redis.cache.windows.net", + "primaryHostName": "cache1.redis.cache.windows.net", + "provisioningState": "Succeeded", + "serverRole": "Secondary" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/linkedServers/cache3", + "name": "cache3", + "type": "Microsoft.Cache/Redis/linkedServers", + "properties": { + "linkedRedisCacheId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache3", + "linkedRedisCacheLocation": "West US", + "geoReplicatedPrimaryHostName": "cache3.geo.redis.cache.windows.net", + "primaryHostName": "cache1.redis.cache.windows.net", + "provisioningState": "Succeeded", + "serverRole": "Secondary" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheList.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheList.json new file mode 100644 index 000000000000..c747cc04ab00 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheList.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "redisVersion": "3.2", + "sku": { + "name": "Standard", + "family": "C", + "capacity": 6 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": {}, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ] + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListByResourceGroup.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListByResourceGroup.json new file mode 100644 index 000000000000..ef9ae9f6bd55 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListByResourceGroup.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "redisVersion": "3.2", + "sku": { + "name": "Standard", + "family": "C", + "capacity": 6 + }, + "enableNonSslPort": true, + "redisConfiguration": {}, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380 + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListKeys.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListKeys.json new file mode 100644 index 000000000000..4e1ea4693f88 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListPrivateEndpointConnections.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListPrivateEndpointConnections.json new file mode 100644 index 000000000000..7b69c1d5a559 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListPrivateEndpointConnections.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + }, + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListPrivateLinkResources.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListPrivateLinkResources.json new file mode 100644 index 000000000000..cf915a251b83 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "rgtest01", + "cacheName": "cacheTest01", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cacheTest01/privateLinkResources/redisCache", + "name": "redisCache", + "type": "Microsoft.Cache/Redis/privateLinkResources", + "properties": { + "groupId": "redisCache", + "requiredMembers": [ + "redisCache" + ], + "requiredZoneNames": [ + "privatelink.redis.cache.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListUpgradeNotifications.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListUpgradeNotifications.json new file mode 100644 index 000000000000..90a530daed0c --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheListUpgradeNotifications.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "history": "5000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "notification1", + "timestamp": "2017-02-16T23:20:50.52Z", + "upsellNotification": {} + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheOperations.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheOperations.json new file mode 100644 index 000000000000..d0255cd65ad3 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheOperations.json @@ -0,0 +1,643 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Cache/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability", + "description": "Checks if a name is available for use with a new Redis Cache" + } + }, + { + "name": "Microsoft.Cache/register/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Register Resource Provider Microsoft.Cache", + "description": "Registers the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/unregister/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Unregister Resource Provider Microsoft.Cache", + "description": "Unregisters the 'Microsoft.Cache' resource provider with a subscription" + } + }, + { + "name": "Microsoft.Cache/operations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "List Provider Operations", + "description": "Lists the operations that 'Microsoft.Cache' provider supports." + } + }, + { + "name": "Microsoft.Cache/locations/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read operation results", + "description": "Gets the result of a long running operation for which the 'Location' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/operationsStatus/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read the status of a long running operation", + "description": "View the status of a long running operation for which the 'AzureAsync' header was previously returned to the client" + } + }, + { + "name": "Microsoft.Cache/locations/asyncOperations/read", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Read asynchronous operation status", + "description": "Read an Async Operation's Status" + } + }, + { + "name": "Microsoft.Cache/locations/checknameavailability/action", + "display": { + "provider": "Microsoft Cache", + "resource": null, + "operation": "Check Cache Name Availability in location", + "description": "Checks if a name is available for use with a new Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redis/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-write)", + "description": "Modify the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Manage Redis Cache (read-only)", + "description": "View the Redis Cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Delete Redis Cache", + "description": "Delete the entire Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "View Redis Cache Access Keys", + "description": "View the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Regenerate Redis Cache Access Keys", + "description": "Change the value of Redis Cache access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Import data into Redis from storage", + "description": "Import data of a specified format from multiple blobs into Redis" + } + }, + { + "name": "Microsoft.Cache/redis/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Export Redis data to storage", + "description": "Export Redis data to prefixed storage blobs in specified format" + } + }, + { + "name": "Microsoft.Cache/redis/forceReboot/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Force reboot a cache instance, potentially with data loss.", + "description": "Force reboot a cache instance, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/stop/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Stop an Azure Cache for Redis, potentially with data loss.", + "description": "Stop an Azure Cache for Redis, potentially with data loss." + } + }, + { + "name": "Microsoft.Cache/redis/start/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache", + "operation": "Start an Azure Cache for Redis", + "description": "Start an Azure Cache for Redis" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Delete Redis Enterprise cache", + "description": "Delete the entire Redis Enterprise cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (read)", + "description": "View the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache", + "operation": "Manage Redis Enterprise cache (write)", + "description": "Modify the Redis Enterprise cache's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Delete Redis Enterprise database", + "description": "Deletes a Redis Enterprise database and its contents" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (read)", + "description": "View the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Manage Redis Enterprise cache database (write)", + "description": "Modify the Redis Enterprise cache database's settings and configuration in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/export/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Export Redis Enterprise database", + "description": "Export data to storage blobs from a Redis Enterprise database " + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/forceUnlink/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Force unlink Redis Enterprise database georeplica", + "description": "Forcibly unlink a georeplica Redis Enterprise database from its peers" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/import/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Import Redis Enterprise database", + "description": "Import data from storage blobs to a Redis Enterprise database" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/listKeys/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "View Redis Enterprise database access keys", + "description": "View the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/regenerateKey/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache database", + "operation": "Regenerate Redis Enterprise database access keys", + "description": "Change the value of Redis Enterprise database access keys in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/databases/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise database operation results", + "operation": "View Redis Enterprise database operation results", + "description": "View the result of Redis Enterprise database operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise operation results", + "operation": "View Redis Enterprise operation results", + "description": "View the result of Redis Enterprise operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Cache", + "operation": "Read Redis Cache Metric Definitions", + "description": "Gets the available metrics for a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Cache", + "resource": "The available metrics for a Redis Enterprise Cache", + "operation": "Read Redis Enterprise Metric Definitions", + "description": "Gets the available metrics for a Redis Enterprise Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Get Redis Cache Patch Schedule", + "description": "Gets the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Change Redis Patching Schedule", + "description": "Modify the patching schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/patchSchedules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Patching schedule of a Redis Cache", + "operation": "Delete Redis Cache Patch Schedule", + "description": "Delete the patch schedule of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/read", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Get Redis Cache Firewall Rule", + "description": "Get the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/write", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Update Redis Cache Firewall Rule", + "description": "Edit the IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/firewallRules/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "IP firewall rule of a Redis Cache", + "operation": "Delete Redis Cache Firewall Rule", + "description": "Delete IP firewall rules of a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Get Redis Cache Linked Servers", + "description": "Get Linked Servers associated with a redis cache." + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Add Redis Cache Linked Server", + "description": "Add Linked Server to a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/linkedServers/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Linked Servers of a Redis Cache", + "operation": "Delete Redis Cache Linked Server", + "description": "Delete Linked Server from a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Get Redis Cache Event Grid Filter", + "description": "Get Redis Cache Event Grid Filter" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Update Redis Cache Event Grid Filters", + "description": "Update Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/eventGridFilters/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Cache Event Grid Filter", + "operation": "Delete Redis Cache Event Grid Filters", + "description": "Delete Redis Cache Event Grid Filters" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/validate/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Validate private endpoint connection proxy", + "description": "Validate the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Get private endpoint connection proxy", + "description": "Get the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Create private endpoint connection proxy", + "description": "Create the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Delete private endpoint connection proxy", + "description": "Delete the private endpoint connection proxy" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnectionProxies/operationResults/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise private endpoint connection proxies", + "operation": "Redis Enterprise cache private endpoint operation results (read)", + "description": "View the result of private endpoint connection operations in the management portal" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Read private endpoint connection", + "description": "Read a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Write private endpoint connection", + "description": "Write a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateEndpointConnections/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private endpoint connections", + "operation": "Delete private endpoint connection", + "description": "Delete a private endpoint connection" + } + }, + { + "name": "Microsoft.Cache/redis/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/privateLinkResources/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Read Private Linkable Resources", + "description": "Read 'groupId' of redis subresource that a private link can be connected to" + } + }, + { + "name": "Microsoft.Cache/redis/roles/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Read Redis Roles", + "description": "Read roles on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Update Redis Roles", + "description": "Create or update role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roles/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Roles", + "operation": "Delete Redis Roles", + "description": "Delete role on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/read", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Read Redis Role Assignments", + "description": "Read role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/write", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Update Redis Role Assignments", + "description": "Create or update role assignments on a Redis Cache" + } + }, + { + "name": "Microsoft.Cache/redis/roleAssignments/delete", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis Role Description", + "operation": "Delete Redis Role Assignment", + "description": "Delete All Redis Role Assignments" + } + }, + { + "name": "Microsoft.Cache/redis/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Azure Cache for Redis private linkable resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + }, + { + "name": "Microsoft.Cache/redisEnterprise/PrivateEndpointConnectionsApproval/action", + "display": { + "provider": "Microsoft Cache", + "resource": "Redis Enterprise cache private link resources", + "operation": "Approve Private Endpoint Connections", + "description": "Approve Private Endpoint Connections" + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesCreateOrUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesCreateOrUpdate.json new file mode 100644 index 000000000000..8b56172dbfc7 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesCreateOrUpdate.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "default": "default", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cachename1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cachename1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesDelete.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesDelete.json new file mode 100644 index 000000000000..a1d3daeb1cf3 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "default": "default", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesGet.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesGet.json new file mode 100644 index 000000000000..4e365efa649f --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "default": "default", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cache1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesList.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesList.json new file mode 100644 index 000000000000..135de803cf17 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePatchSchedulesList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "cacheName": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1/patchSchedules/default", + "location": "East US", + "name": "cache1/default", + "type": "Microsoft.Cache/Redis/PatchSchedules", + "properties": { + "scheduleEntries": [ + { + "dayOfWeek": "Monday", + "startHourUtc": 12, + "maintenanceWindow": "PT5H" + }, + { + "dayOfWeek": "Tuesday", + "startHourUtc": 12 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePutPrivateEndpointConnection.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePutPrivateEndpointConnection.json new file mode 100644 index 000000000000..4bc31889ab56 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCachePutPrivateEndpointConnection.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "rgtest01", + "cacheName": "cachetest01", + "privateEndpointConnectionName": "pectest01", + "api-version": "2023-05-01-preview", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Cache/Redis/cachetest01/privateEndpointConnections/pectest01", + "name": "pectest01", + "type": "Microsoft.Cache/Redis/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/rgtest01/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheRegenerateKey.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheRegenerateKey.json new file mode 100644 index 000000000000..d79674eb27c3 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheRegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "keyType": "Primary" + } + }, + "responses": { + "200": { + "body": { + "primaryKey": "", + "secondaryKey": "" + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheUpdate.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheUpdate.json new file mode 100644 index 000000000000..dd4ecdd974a9 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheUpdate.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "name": "cache1", + "resourceGroupName": "rg1", + "api-version": "2023-05-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "enableNonSslPort": true, + "replicasPerPrimary": 2 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "3.0", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Cache/Redis/cache1", + "location": "West US", + "name": "cache1", + "type": "Microsoft.Cache/Redis", + "tags": {}, + "properties": { + "accessKeys": { + "primaryKey": "", + "secondaryKey": "" + }, + "provisioningState": "Succeeded", + "redisVersion": "3.0", + "sku": { + "name": "Premium", + "family": "P", + "capacity": 1 + }, + "enableNonSslPort": true, + "replicasPerMaster": 2, + "replicasPerPrimary": 2, + "redisConfiguration": { + "maxclients": "1000", + "maxmemory-reserved": "50", + "maxmemory-delta": "50" + }, + "hostName": "cache1.redis.cache.windows.net", + "port": 6379, + "sslPort": 6380, + "instances": [ + { + "sslPort": 15000, + "nonSslPort": 13000, + "isMaster": true, + "isPrimary": true + }, + { + "sslPort": 15001, + "nonSslPort": 13001, + "isMaster": false, + "isPrimary": false + }, + { + "sslPort": 15002, + "nonSslPort": 13002, + "isMaster": false, + "isPrimary": false + } + ] + } + }, + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Cache/...pathToOperationResult..." + } + } + } +} diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/redis.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/redis.json new file mode 100644 index 000000000000..78694fead0f5 --- /dev/null +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/redis.json @@ -0,0 +1,3288 @@ +{ + "swagger": "2.0", + "info": { + "title": "RedisManagementClient", + "description": "REST API for Azure Redis Cache Service.", + "version": "2023-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": { + "/providers/Microsoft.Cache/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available REST API operations of the Microsoft.Cache provider.", + "operationId": "Operations_List", + "x-ms-examples": { + "RedisCacheOperations": { + "$ref": "./examples/RedisCacheOperations.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/CheckNameAvailability": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_CheckNameAvailability", + "x-ms-examples": { + "RedisCacheCheckNameAvailability": { + "$ref": "./examples/RedisCacheCheckNameAvailability.json" + } + }, + "description": "Checks that the redis cache name is valid and is not already in use.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + }, + "description": "Parameters supplied to the CheckNameAvailability Redis operation. The only supported resource type is 'Microsoft.Cache/redis'" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Name is available" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/listUpgradeNotifications": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListUpgradeNotifications", + "x-ms-examples": { + "RedisCacheListUpgradeNotifications": { + "$ref": "./examples/RedisCacheListUpgradeNotifications.json" + } + }, + "description": "Gets any upgrade notifications for a Redis cache.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "history", + "in": "query", + "required": true, + "type": "number", + "format": "double", + "description": "how many minutes in past to look for upgrade notifications" + } + ], + "responses": { + "200": { + "description": "All upgrade notifications in given time range", + "schema": { + "$ref": "#/definitions/NotificationListResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}": { + "put": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Create", + "x-ms-examples": { + "RedisCacheCreateDefaultVersion": { + "$ref": "./examples/RedisCacheCreateDefaultVersion.json" + }, + "RedisCacheCreateLatestVersion": { + "$ref": "./examples/RedisCacheCreateLatestVersion.json" + }, + "RedisCacheCreate": { + "$ref": "./examples/RedisCacheCreate.json" + } + }, + "description": "Create or replace (overwrite/recreate, with potential downtime) an existing Redis cache.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisCreateParameters" + }, + "description": "Parameters supplied to the Create Redis operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "The new redis cache was successfully created. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "200": { + "description": "The existing redis cache was successfully updated. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Update", + "x-ms-examples": { + "RedisCacheUpdate": { + "$ref": "./examples/RedisCacheUpdate.json" + } + }, + "description": "Update an existing Redis cache.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisUpdateParameters" + }, + "description": "Parameters supplied to the Update Redis operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing redis cache was successfully updated. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "202": { + "description": "The existing redis cache was successfully updated. Check Azure-AsyncOperation headers to poll detailed status.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Delete", + "x-ms-examples": { + "RedisCacheDelete": { + "$ref": "./examples/RedisCacheDelete.json" + } + }, + "description": "Deletes a Redis cache.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The redis cache was successfully deleted." + }, + "202": { + "description": "The redis cache 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome." + }, + "204": { + "description": "The redis cache was successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_Get", + "x-ms-examples": { + "RedisCacheGet": { + "$ref": "./examples/RedisCacheGet.json" + } + }, + "description": "Gets a Redis cache (resource description).", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The redis cache was successfully found.", + "schema": { + "$ref": "#/definitions/RedisResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListByResourceGroup", + "x-ms-examples": { + "RedisCacheListByResourceGroup": { + "$ref": "./examples/RedisCacheListByResourceGroup.json" + } + }, + "description": "Lists all Redis caches in a resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/RedisListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/redis": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListBySubscription", + "x-ms-examples": { + "RedisCacheList": { + "$ref": "./examples/RedisCacheList.json" + } + }, + "description": "Gets all Redis caches in 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": "", + "schema": { + "$ref": "#/definitions/RedisListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/listKeys": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ListKeys", + "x-ms-examples": { + "RedisCacheListKeys": { + "$ref": "./examples/RedisCacheListKeys.json" + } + }, + "description": "Retrieve a Redis cache's access keys. This operation requires write permission to the cache resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists the keys for the specified Redis cache.", + "schema": { + "$ref": "#/definitions/RedisAccessKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/regenerateKey": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_RegenerateKey", + "x-ms-examples": { + "RedisCacheRegenerateKey": { + "$ref": "./examples/RedisCacheRegenerateKey.json" + } + }, + "description": "Regenerate Redis cache's access keys. This operation requires write permission to the cache resource.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisRegenerateKeyParameters" + }, + "description": "Specifies which key to regenerate." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Lists the regenerated keys for Redis Cache", + "schema": { + "$ref": "#/definitions/RedisAccessKeys" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/forceReboot": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ForceReboot", + "x-ms-examples": { + "RedisCacheForceReboot": { + "$ref": "./examples/RedisCacheForceReboot.json" + } + }, + "description": "Reboot specified Redis node(s). This operation requires write permission to the cache resource. There can be potential data loss.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisRebootParameters" + }, + "description": "Specifies which Redis node(s) to reboot." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Reboot operation successfully enqueued", + "schema": { + "$ref": "#/definitions/RedisForceRebootResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/import": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ImportData", + "x-ms-examples": { + "RedisCacheImport": { + "$ref": "./examples/RedisCacheImport.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Import data into Redis cache.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImportRDBParameters" + }, + "description": "Parameters for Redis import operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Import operation successfully enqueued; follow the Location header to poll for final outcome." + }, + "200": { + "description": "Import operation succeeded." + }, + "204": { + "description": "Import operation succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/export": { + "post": { + "tags": [ + "Redis" + ], + "operationId": "Redis_ExportData", + "x-ms-examples": { + "RedisCacheExport": { + "$ref": "./examples/RedisCacheExport.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Export data from the redis cache to blobs in a container.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExportRDBParameters" + }, + "description": "Parameters for Redis export operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Export operation successfully enqueued; follow the Location header to poll for final outcome." + }, + "200": { + "description": "Export operation succeeded." + }, + "204": { + "description": "Export operation succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules": { + "get": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_List", + "description": "Gets all firewall rules in the specified redis cache.", + "x-ms-examples": { + "RedisCacheFirewallRulesList": { + "$ref": "./examples/RedisCacheFirewallRulesList.json" + } + }, + "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/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully got the current rules", + "schema": { + "$ref": "#/definitions/RedisFirewallRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/firewallRules/{ruleName}": { + "put": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_CreateOrUpdate", + "description": "Create or update a redis cache firewall rule", + "x-ms-examples": { + "RedisCacheFirewallRuleCreate": { + "$ref": "./examples/RedisCacheFirewallRuleCreate.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + }, + "description": "Parameters supplied to the create or update redis firewall rule operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Resource was successfully updated", + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + } + }, + "201": { + "description": "Resource was successfully created", + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_Get", + "description": "Gets a single firewall rule in a specified redis cache.", + "x-ms-examples": { + "RedisCacheFirewallRuleGet": { + "$ref": "./examples/RedisCacheFirewallRuleGet.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully found the rule", + "schema": { + "$ref": "#/definitions/RedisFirewallRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis", + "FirewallRules" + ], + "operationId": "FirewallRules_Delete", + "description": "Deletes a single firewall rule in a specified redis cache.", + "x-ms-examples": { + "RedisCacheFirewallRuleDelete": { + "$ref": "./examples/RedisCacheFirewallRuleDelete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the firewall rule." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the rule" + }, + "204": { + "description": "Successfully deleted the rule" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/patchSchedules": { + "get": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_ListByRedisResource", + "description": "Gets all patch schedules in the specified redis cache (there is only one).", + "x-ms-examples": { + "RedisCachePatchSchedulesList": { + "$ref": "./examples/RedisCachePatchSchedulesList.json" + } + }, + "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/CacheNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully got the current patch schedules", + "schema": { + "$ref": "#/definitions/RedisPatchScheduleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/patchSchedules/{default}": { + "put": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_CreateOrUpdate", + "x-ms-examples": { + "RedisCachePatchSchedulesCreateOrUpdate": { + "$ref": "./examples/RedisCachePatchSchedulesCreateOrUpdate.json" + } + }, + "description": "Create or replace the patching schedule for Redis cache.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "default", + "in": "path", + "required": true, + "type": "string", + "description": "Default string modeled as parameter for auto generation to work correctly.", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "defaultName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + }, + "description": "Parameters to set the patching schedule for Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The patch schedule was successfully updated.", + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + } + }, + "201": { + "description": "The patch schedule was successfully created.", + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_Delete", + "x-ms-examples": { + "RedisCachePatchSchedulesDelete": { + "$ref": "./examples/RedisCachePatchSchedulesDelete.json" + } + }, + "description": "Deletes the patching schedule of a redis cache.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "default", + "in": "path", + "required": true, + "type": "string", + "description": "Default string modeled as parameter for auto generation to work correctly.", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "defaultName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "204": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis", + "PatchSchedules" + ], + "operationId": "PatchSchedules_Get", + "x-ms-examples": { + "RedisCachePatchSchedulesGet": { + "$ref": "./examples/RedisCachePatchSchedulesGet.json" + } + }, + "description": "Gets the patching schedule of a redis cache.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "default", + "in": "path", + "required": true, + "type": "string", + "description": "Default string modeled as parameter for auto generation to work correctly.", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "defaultName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get patch schedules.", + "schema": { + "$ref": "#/definitions/RedisPatchSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers/{linkedServerName}": { + "put": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_Create", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "LinkedServer_Create": { + "$ref": "./examples/RedisCacheLinkedServer_Create.json" + } + }, + "description": "Adds a linked server to the Redis cache (requires Premium SKU).", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache." + }, + { + "name": "linkedServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the linked server that is being added to the Redis cache." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisLinkedServerCreateParameters" + }, + "description": "Parameters supplied to the Create Linked server operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The linked server was successfully updated.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + } + }, + "201": { + "description": "The linked server was successfully created.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_Delete", + "x-ms-examples": { + "LinkedServerDelete": { + "$ref": "./examples/RedisCacheLinkedServer_Delete.json" + } + }, + "description": "Deletes the linked server from a redis cache (requires Premium SKU).", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "linkedServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the linked server that is being added to the Redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Linked server was successfully deleted." + }, + "202": { + "headers": { + "Location": { + "type": "string" + } + }, + "description": "The linked server 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_Get", + "x-ms-examples": { + "LinkedServer_Get": { + "$ref": "./examples/RedisCacheLinkedServer_Get.json" + } + }, + "description": "Gets the detailed information about a linked server of a redis cache (requires Premium SKU).", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "name": "linkedServerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the linked server." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get linked server.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{name}/linkedServers": { + "get": { + "tags": [ + "Redis" + ], + "operationId": "LinkedServer_List", + "x-ms-examples": { + "LinkedServer_List": { + "$ref": "./examples/RedisCacheLinkedServer_List.json" + } + }, + "description": "Gets the list of linked servers associated with this redis cache (requires Premium SKU).", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the redis cache." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get linked servers.", + "schema": { + "$ref": "#/definitions/RedisLinkedServerWithPropertiesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "description": "List all the private endpoint connections associated with the redis cache.", + "x-ms-examples": { + "RedisCacheListPrivateEndpointConnection": { + "$ref": "./examples/RedisCacheListPrivateEndpointConnections.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Successfully retrieved private endpoint connections.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the redis cache.", + "x-ms-examples": { + "RedisCacheGetPrivateEndpointConnection": { + "$ref": "./examples/RedisCacheGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Put", + "description": "Update the state of specified private endpoint connection associated with the redis cache.", + "x-ms-examples": { + "RedisCachePutPrivateEndpointConnection": { + "$ref": "./examples/RedisCachePutPrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$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/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the redis cache.", + "x-ms-examples": { + "RedisCacheDeletePrivateEndpointConnection": { + "$ref": "./examples/RedisCacheDeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$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/v1/privatelinks.json#/parameters/PrivateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "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/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByRedisCache", + "description": "Gets the private link resources that need to be created for a redis cache.", + "x-ms-examples": { + "StorageAccountListPrivateLinkResources": { + "$ref": "./examples/RedisCacheListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Cache/locations/{location}/asyncOperations/{operationId}": { + "get": { + "tags": [ + "AsyncOperationStatus" + ], + "operationId": "AsyncOperationStatus_Get", + "description": "For checking the ongoing status of an operation", + "x-ms-examples": { + "RedisCacheAsyncOperationStatus": { + "$ref": "./examples/RedisCacheAsyncOperationStatus.json" + } + }, + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location at which operation was triggered" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of asynchronous operation" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Asynchronous operation status response", + "schema": { + "$ref": "#/definitions/OperationStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies/{accessPolicyName}": { + "put": { + "tags": [ + "Redis", + "AAD" + ], + "operationId": "AccessPolicy_CreateUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RedisCacheAccessPolicyCreateUpdate": { + "$ref": "./examples/RedisCacheAccessPolicyCreateUpdate.json" + } + }, + "description": "Adds an access policy to the redis cache", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisCacheAccessPolicy" + }, + "description": "Parameters supplied to the Create Update Access Policy operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing access policy was successfully updated. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisCacheAccessPolicy" + } + }, + "201": { + "description": "The new access policy was successfully created. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisCacheAccessPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis", + "AAD" + ], + "operationId": "AccessPolicy_Delete", + "x-ms-examples": { + "RedisCacheAccessPolicyDelete": { + "$ref": "./examples/RedisCacheAccessPolicyDelete.json" + } + }, + "description": "Deletes the access policy from a redis cache", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the access policy" + }, + "204": { + "description": "Successfully deleted the access policy" + }, + "202": { + "description": "The access policy 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis", + "AAD" + ], + "operationId": "AccessPolicy_Get", + "x-ms-examples": { + "RedisCacheAccessPolicyGet": { + "$ref": "./examples/RedisCacheAccessPolicyGet.json" + } + }, + "description": "Gets the detailed information about an access policy of a redis cache", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get access policy.", + "schema": { + "$ref": "#/definitions/RedisCacheAccessPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicies": { + "get": { + "tags": [ + "Redis", + "AAD" + ], + "operationId": "AccessPolicy_List", + "x-ms-examples": { + "RedisCacheAccessPolicyList": { + "$ref": "./examples/RedisCacheAccessPolicyList.json" + } + }, + "description": "Gets the list of access policies associated with this redis cache", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of list access policies.", + "schema": { + "$ref": "#/definitions/RedisCacheAccessPolicyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments/{accessPolicyAssignmentName}": { + "put": { + "tags": [ + "Redis", + "AAD" + ], + "operationId": "AccessPolicyAssignment_CreateUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RedisCacheAccessPolicyAssignmentCreateUpdate": { + "$ref": "./examples/RedisCacheAccessPolicyAssignmentCreateUpdate.json" + } + }, + "description": "Adds the access policy assignment to the specified users", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyAssignmentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RedisCacheAccessPolicyAssignment" + }, + "description": "Parameters supplied to the Create Update Access Policy Assignment operation." + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The existing access policy assignment was successfully updated. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisCacheAccessPolicyAssignment" + } + }, + "201": { + "description": "The new access policy assignment was successfully created. Check provisioningState to see detailed status.", + "schema": { + "$ref": "#/definitions/RedisCacheAccessPolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Redis", + "AAD" + ], + "operationId": "AccessPolicyAssignment_Delete", + "x-ms-examples": { + "RedisCacheAccessPolicyAssignmentDelete": { + "$ref": "./examples/RedisCacheAccessPolicyAssignmentDelete.json" + } + }, + "description": "Deletes the access policy assignment from a redis cache", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyAssignmentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the access policy assignment" + }, + "204": { + "description": "Successfully deleted the access policy assignment" + }, + "202": { + "description": "The access policy assignment 'delete' operation was successfully enqueued; follow the Location header to poll for final outcome.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Redis", + "AAD" + ], + "operationId": "AccessPolicyAssignment_Get", + "x-ms-examples": { + "RedisCacheAccessPolicyAssignmentGet": { + "$ref": "./examples/RedisCacheAccessPolicyAssignmentGet.json" + } + }, + "description": "Gets the list of assignments for an access policy of a redis cache", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyAssignmentNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of get access policy assignments.", + "schema": { + "$ref": "#/definitions/RedisCacheAccessPolicyAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cache/redis/{cacheName}/accessPolicyAssignments": { + "get": { + "tags": [ + "Redis", + "AAD" + ], + "operationId": "AccessPolicyAssignment_List", + "x-ms-examples": { + "RedisCacheAccessPolicyAssignmentList": { + "$ref": "./examples/RedisCacheAccessPolicyAssignmentList.json" + } + }, + "description": "Gets the list of access policy assignments associated with this redis cache", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/CacheNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Response of list access policy assignments.", + "schema": { + "$ref": "#/definitions/RedisCacheAccessPolicyAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The type of Redis cache to deploy. Valid values: (Basic, Standard, Premium)", + "enum": [ + "Basic", + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "family": { + "type": "string", + "description": "The SKU family to use. Valid values: (C, P). (C = Basic/Standard, P = Premium).", + "enum": [ + "C", + "P" + ], + "x-ms-enum": { + "name": "SkuFamily", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The size of the Redis cache to deploy. Valid values: for C (Basic/Standard) family (0, 1, 2, 3, 4, 5, 6), for P (Premium) family (1, 2, 3, 4)." + } + }, + "required": [ + "name", + "family", + "capacity" + ], + "description": "SKU parameters supplied to the create Redis operation." + }, + "RedisCommonProperties": { + "properties": { + "redisConfiguration": { + "type": "object", + "properties": { + "rdb-backup-enabled": { + "type": "string", + "description": "Specifies whether the rdb backup is enabled" + }, + "rdb-backup-frequency": { + "type": "string", + "description": "Specifies the frequency for creating rdb backup in minutes. Valid values: (15, 30, 60, 360, 720, 1440)" + }, + "rdb-backup-max-snapshot-count": { + "type": "string", + "description": "Specifies the maximum number of snapshots for rdb backup" + }, + "rdb-storage-connection-string": { + "type": "string", + "description": "The storage account connection string for storing rdb file" + }, + "aof-backup-enabled": { + "type": "string", + "description": "Specifies whether the aof backup is enabled" + }, + "aof-storage-connection-string-0": { + "type": "string", + "description": "First storage account connection string" + }, + "aof-storage-connection-string-1": { + "type": "string", + "description": "Second storage account connection string" + }, + "maxfragmentationmemory-reserved": { + "type": "string", + "description": "Value in megabytes reserved for fragmentation per shard" + }, + "maxmemory-policy": { + "type": "string", + "description": "The eviction strategy used when your data won't fit within its memory limit." + }, + "maxmemory-reserved": { + "type": "string", + "description": "Value in megabytes reserved for non-cache usage per shard e.g. failover." + }, + "maxmemory-delta": { + "type": "string", + "description": "Value in megabytes reserved for non-cache usage per shard e.g. failover." + }, + "maxclients": { + "type": "string", + "description": "The max clients config", + "readOnly": true + }, + "preferred-data-archive-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS", + "readOnly": true + }, + "preferred-data-persistence-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data persistence, specify SAS or ManagedIdentity, default value is SAS" + }, + "zonal-configuration": { + "type": "string", + "description": "Zonal Configuration", + "readOnly": true + }, + "authnotrequired": { + "type": "string", + "description": "Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view." + }, + "aad-enabled": { + "type": "string", + "description": "Specifies whether AAD based authentication has been enabled or disabled for the cache" + } + }, + "additionalProperties": {}, + "description": "All Redis Settings. Few possible keys: rdb-backup-enabled,rdb-storage-connection-string,rdb-backup-frequency,maxmemory-delta,maxmemory-policy,notify-keyspace-events,maxmemory-samples,slowlog-log-slower-than,slowlog-max-len,list-max-ziplist-entries,list-max-ziplist-value,hash-max-ziplist-entries,hash-max-ziplist-value,set-max-intset-entries,zset-max-ziplist-entries,zset-max-ziplist-value etc." + }, + "redisVersion": { + "type": "string", + "description": "Redis version. This should be in the form 'major[.minor]' (only 'major' is required) or the value 'latest' which refers to the latest stable Redis version that is available. Supported versions: 4.0, 6.0 (latest). Default value is 'latest'." + }, + "enableNonSslPort": { + "type": "boolean", + "default": false, + "description": "Specifies whether the non-ssl Redis server port (6379) is enabled." + }, + "replicasPerMaster": { + "type": "integer", + "format": "int32", + "description": "The number of replicas to be created per primary." + }, + "replicasPerPrimary": { + "type": "integer", + "format": "int32", + "description": "The number of replicas to be created per primary." + }, + "tenantSettings": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of tenant settings" + }, + "shardCount": { + "type": "integer", + "format": "int32", + "description": "The number of shards to be created on a Premium Cluster Cache." + }, + "minimumTlsVersion": { + "type": "string", + "description": "Optional: requires clients to use a specified TLS version (or higher) to connect (e,g, '1.0', '1.1', '1.2')", + "enum": [ + "1.0", + "1.1", + "1.2" + ], + "x-ms-enum": { + "name": "TlsVersion", + "modelAsString": true + } + }, + "publicNetworkAccess": { + "description": "Whether or not public endpoint access is allowed for this cache. Value is optional but if passed in, must be 'Enabled' or 'Disabled'. If 'Disabled', private endpoints are the exclusive access method. Default value is 'Enabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "default": "Enabled", + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + } + }, + "description": "Create/Update/Get common properties of the redis cache.", + "x-ms-external": true + }, + "RedisCreateProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the Redis cache to deploy." + }, + "subnetId": { + "type": "string", + "pattern": "^/subscriptions/[^/]*/resourceGroups/[^/]*/providers/Microsoft.(ClassicNetwork|Network)/virtualNetworks/[^/]*/subnets/[^/]*$", + "description": "The full resource ID of a subnet in a virtual network to deploy the Redis cache in. Example format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/vnet1/subnets/subnet1" + }, + "staticIP": { + "type": "string", + "pattern": "^\\d+\\.\\d+\\.\\d+\\.\\d+$", + "description": "Static IP address. Optionally, may be specified when deploying a Redis cache inside an existing Azure Virtual Network; auto assigned by default.", + "x-ms-mutability": [ + "read", + "create" + ] + } + }, + "required": [ + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/RedisCommonProperties" + } + ], + "description": "Properties supplied to Create Redis operation.", + "x-ms-external": true + }, + "RedisUpdateProperties": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the Redis cache to deploy." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RedisCommonProperties" + } + ], + "description": "Patchable properties of the redis cache.", + "x-ms-external": true + }, + "RedisProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Redis instance provisioning status.", + "enum": [ + "Creating", + "Deleting", + "Disabled", + "Failed", + "Linking", + "Provisioning", + "RecoveringScaleFailure", + "Scaling", + "Succeeded", + "Unlinking", + "Unprovisioning", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "hostName": { + "readOnly": true, + "type": "string", + "description": "Redis host name." + }, + "port": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Redis non-SSL port." + }, + "sslPort": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Redis SSL port." + }, + "accessKeys": { + "readOnly": true, + "$ref": "#/definitions/RedisAccessKeys", + "description": "The keys of the Redis cache - not set if this object is not the response to Create or Update redis cache" + }, + "linkedServers": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RedisLinkedServer" + }, + "description": "List of the linked servers associated with the cache" + }, + "instances": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RedisInstanceDetails" + }, + "x-ms-identifiers": [ + "shardId" + ], + "description": "List of the Redis instances associated with the cache" + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "List of private endpoint connection associated with the specified redis cache" + } + }, + "allOf": [ + { + "$ref": "#/definitions/RedisCreateProperties" + } + ], + "description": "Properties of the redis cache.", + "x-ms-external": true + }, + "RedisCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisCreateProperties", + "description": "Redis cache properties." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The geo-location where the resource lives" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + } + }, + "required": [ + "properties", + "location" + ], + "description": "Parameters supplied to the Create Redis operation." + }, + "RedisUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisUpdateProperties", + "description": "Redis cache properties." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + } + }, + "description": "Parameters supplied to the Update Redis operation." + }, + "RedisAccessKeys": { + "properties": { + "primaryKey": { + "readOnly": true, + "type": "string", + "description": "The current primary key that clients can use to authenticate with Redis cache." + }, + "secondaryKey": { + "readOnly": true, + "type": "string", + "description": "The current secondary key that clients can use to authenticate with Redis cache." + } + }, + "description": "Redis cache access keys." + }, + "RedisFirewallRule": { + "description": "A firewall rule on a redis cache has a name, and describes a contiguous range of IP addresses permitted to connect", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisFirewallRuleProperties", + "description": "redis cache firewall rule properties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RedisFirewallRuleCreateParameters": { + "allOf": [ + { + "$ref": "#/definitions/RedisFirewallRule" + } + ], + "description": "Parameters required for creating a firewall rule on redis cache. (Note, you can just use the FirewallRule type instead now.)" + }, + "RedisFirewallRuleProperties": { + "description": "Specifies a range of IP addresses permitted to connect to the cache", + "properties": { + "startIP": { + "type": "string", + "description": "lowest IP address included in the range" + }, + "endIP": { + "type": "string", + "description": "highest IP address included in the range" + } + }, + "required": [ + "startIP", + "endIP" + ] + }, + "RedisFirewallRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisFirewallRule" + }, + "description": "Results of the list firewall rules operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list firewall rules Redis operation." + }, + "RedisResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisProperties", + "description": "Redis cache properties." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "identity": { + "$ref": "../../../../../common-types/resource-management/v4/managedidentity.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the resource." + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource" + } + ], + "description": "A single Redis item in List or Get Operation." + }, + "RedisInstanceDetails": { + "properties": { + "sslPort": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Redis instance SSL port." + }, + "nonSslPort": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "If enableNonSslPort is true, provides Redis instance Non-SSL port." + }, + "zone": { + "readOnly": true, + "type": "string", + "description": "If the Cache uses availability zones, specifies availability zone where this instance is located." + }, + "shardId": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "If clustering is enabled, the Shard ID of Redis Instance" + }, + "isMaster": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the instance is a primary node." + }, + "isPrimary": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the instance is a primary node." + } + }, + "description": "Details of single instance of redis." + }, + "RedisListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisResource" + }, + "description": "List of Redis cache instances." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list Redis operation." + }, + "RedisRegenerateKeyParameters": { + "properties": { + "keyType": { + "type": "string", + "description": "The Redis access key to regenerate.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "RedisKeyType", + "modelAsString": false + } + } + }, + "required": [ + "keyType" + ], + "description": "Specifies which Redis access keys to reset." + }, + "RedisRebootParameters": { + "properties": { + "rebootType": { + "type": "string", + "description": "Which Redis node(s) to reboot. Depending on this value data loss is possible.", + "enum": [ + "PrimaryNode", + "SecondaryNode", + "AllNodes" + ], + "x-ms-enum": { + "name": "RebootType", + "modelAsString": true + } + }, + "shardId": { + "type": "integer", + "format": "int32", + "description": "If clustering is enabled, the ID of the shard to be rebooted." + }, + "ports": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "A list of redis instances to reboot, specified by per-instance SSL ports or non-SSL ports." + } + }, + "description": "Specifies which Redis node(s) to reboot." + }, + "ExportRDBParameters": { + "properties": { + "format": { + "type": "string", + "description": "File format." + }, + "prefix": { + "type": "string", + "description": "Prefix to use for exported files." + }, + "container": { + "type": "string", + "description": "Container name to export to." + }, + "preferred-data-archive-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS" + } + }, + "required": [ + "container", + "prefix" + ], + "description": "Parameters for Redis export operation." + }, + "ImportRDBParameters": { + "properties": { + "format": { + "type": "string", + "description": "File format." + }, + "files": { + "type": "array", + "description": "files to import.", + "items": { + "type": "string" + } + }, + "preferred-data-archive-auth-method": { + "type": "string", + "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS" + } + }, + "required": [ + "files" + ], + "description": "Parameters for Redis import operation." + }, + "ScheduleEntry": { + "properties": { + "dayOfWeek": { + "type": "string", + "description": "Day of the week when a cache can be patched.", + "enum": [ + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday", + "Everyday", + "Weekend" + ], + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": false + } + }, + "startHourUtc": { + "type": "integer", + "format": "int32", + "description": "Start hour after which cache patching can start." + }, + "maintenanceWindow": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying how much time cache patching can take. " + } + }, + "required": [ + "dayOfWeek", + "startHourUtc" + ], + "description": "Patch schedule entry for a Premium Redis Cache." + }, + "ScheduleEntries": { + "properties": { + "scheduleEntries": { + "x-ms-client-name": "ScheduleEntries", + "type": "array", + "items": { + "$ref": "#/definitions/ScheduleEntry" + }, + "x-ms-identifiers": [], + "description": "List of patch schedules for a Redis cache." + } + }, + "required": [ + "scheduleEntries" + ], + "description": "List of patch schedules for a Redis cache." + }, + "RedisPatchSchedule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ScheduleEntries", + "description": "List of patch schedules for a Redis cache." + }, + "location": { + "type": "string", + "description": "The geo-location where the resource lives", + "readOnly": true + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Response to put/get patch schedules for Redis cache." + }, + "RedisPatchScheduleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisPatchSchedule" + }, + "description": "Results of the list patch schedules operation." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next page of results." + } + }, + "description": "The response of list patch schedules Redis operation." + }, + "RedisForceRebootResponse": { + "properties": { + "message": { + "readOnly": true, + "type": "string", + "description": "Status message" + } + }, + "description": "Response to force reboot for Redis cache." + }, + "RedisLinkedServer": { + "description": "Linked server Id", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Linked server Id." + } + } + }, + "RedisLinkedServerWithProperties": { + "description": "Response to put/get linked server (with properties) for Redis cache.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisLinkedServerProperties", + "description": "Properties of the linked server." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ] + }, + "RedisLinkedServerProperties": { + "description": "Properties of a linked server to be returned in get/put response", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Terminal state of the link between primary and secondary redis cache." + } + }, + "allOf": [ + { + "$ref": "#/definitions/RedisLinkedServerCreateProperties" + } + ] + }, + "RedisLinkedServerWithPropertiesList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisLinkedServerWithProperties" + }, + "description": "List of linked servers (with properties) of a Redis cache." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next set." + } + }, + "description": "List of linked servers (with properties) of a Redis cache." + }, + "RedisLinkedServerCreateProperties": { + "description": "Create properties for a linked server", + "properties": { + "linkedRedisCacheId": { + "type": "string", + "description": "Fully qualified resourceId of the linked redis cache." + }, + "linkedRedisCacheLocation": { + "type": "string", + "description": "Location of the linked redis cache.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "serverRole": { + "type": "string", + "description": "Role of the linked server.", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "ReplicationRole", + "modelAsString": false + } + }, + "geoReplicatedPrimaryHostName": { + "type": "string", + "readOnly": true, + "description": "The unchanging DNS name which will always point to current geo-primary cache among the linked redis caches for seamless Geo Failover experience." + }, + "primaryHostName": { + "type": "string", + "readOnly": true, + "description": "The changing DNS name that resolves to the current geo-primary cache among the linked redis caches before or after the Geo Failover." + } + }, + "required": [ + "linkedRedisCacheId", + "linkedRedisCacheLocation", + "serverRole" + ] + }, + "RedisLinkedServerCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisLinkedServerCreateProperties", + "description": "Properties required to create a linked server." + } + }, + "required": [ + "properties" + ], + "description": "Parameter required for creating a linked server to redis cache." + }, + "RedisCacheAccessPolicyProperties": { + "properties": { + "provisioningState": { + "type": "string", + "description": "Provisioning state of access policy", + "readOnly": true, + "enum": [ + "Updating", + "Succeeded", + "Deleting", + "Deleted", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "AccessPolicyProvisioningState", + "modelAsString": true + } + }, + "type": { + "type": "string", + "description": "Built-In or Custom access policy", + "readOnly": true, + "enum": [ + "Custom", + "BuiltIn" + ], + "x-ms-enum": { + "name": "AccessPolicyType", + "modelAsString": true + } + }, + "permissions": { + "type": "string", + "description": "Permissions for the access policy. Learn how to configure permissions at https://aka.ms/redis/AADPreRequisites" + } + }, + "required": [ + "permissions" + ], + "description": "All properties of an access policy.", + "type": "object" + }, + "RedisCacheAccessPolicy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisCacheAccessPolicyProperties", + "description": "Properties of an access policy." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Response to get/put access policy.", + "type": "object" + }, + "RedisCacheAccessPolicyList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisCacheAccessPolicy" + }, + "description": "List of access policies (with properties) of a Redis cache." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next set." + } + }, + "description": "List of access policies (with properties) of a Redis cache.", + "type": "object" + }, + "RedisCacheAccessPolicyAssignmentProperties": { + "description": "Properties for an access policy assignment", + "properties": { + "provisioningState": { + "type": "string", + "description": "Provisioning state of an access policy assignment set", + "readOnly": true, + "enum": [ + "Updating", + "Succeeded", + "Deleting", + "Deleted", + "Canceled", + "Failed" + ], + "x-ms-enum": { + "name": "AccessPolicyAssignmentProvisioningState", + "modelAsString": true + } + }, + "objectId": { + "type": "string", + "description": "Object Id to assign access policy to" + }, + "objectIdAlias": { + "type": "string", + "description": "User friendly name for object id. Also represents username for token based authentication" + }, + "accessPolicyName": { + "type": "string", + "description": "The name of the access policy that is being assigned", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$" + } + }, + "required": [ + "objectId", + "objectIdAlias", + "accessPolicyName" + ], + "type": "object" + }, + "RedisCacheAccessPolicyAssignment": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RedisCacheAccessPolicyAssignmentProperties", + "description": "Properties of an access policy assignment" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ProxyResource" + } + ], + "description": "Response to an operation on access policy assignment", + "type": "object" + }, + "RedisCacheAccessPolicyAssignmentList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RedisCacheAccessPolicyAssignment" + }, + "description": "List of access policies assignments (with properties) of a Redis cache." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next set." + } + }, + "description": "List of access policies assignments (with properties) of a Redis cache.", + "type": "object" + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that describes the operation.", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "operation": { + "description": "Operation type: read, write, delete, listKeys/action, etc.", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "description": "Friendly name of the operation", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "CheckNameAvailabilityParameters": { + "description": "Parameters body to pass for resource name availability check.", + "properties": { + "name": { + "type": "string", + "description": "Resource name." + }, + "type": { + "type": "string", + "description": "Resource type. The only legal value of this property for checking redis cache name availability is 'Microsoft.Cache/redis'." + } + }, + "required": [ + "name", + "type" + ] + }, + "UpgradeNotification": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of upgrade notification." + }, + "timestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Timestamp when upgrade notification occurred." + }, + "upsellNotification": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Details about this upgrade notification" + } + }, + "description": "Properties of upgrade notification." + }, + "NotificationListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UpgradeNotification" + }, + "x-ms-identifiers": [ + "name", + "timestamp" + ], + "description": "List of all notifications." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "Link for next set of notifications." + } + }, + "description": "The response of listUpgradeNotifications." + }, + "OperationStatus": { + "type": "object", + "description": "Asynchronous operation status", + "properties": { + "properties": { + "description": "Additional properties from RP, only when operation is successful", + "type": "object", + "additionalProperties": {} + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/OperationStatusResult" + } + ] + } + }, + "parameters": { + "CacheNameParameter": { + "name": "cacheName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Redis cache.", + "x-ms-parameter-location": "method", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$" + }, + "AccessPolicyNameParameter": { + "name": "accessPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the access policy that is being added to the Redis cache.", + "x-ms-parameter-location": "method", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$", + "minLength": 3, + "maxLength": 63 + }, + "AccessPolicyAssignmentNameParameter": { + "name": "accessPolicyAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the access policy assignment.", + "x-ms-parameter-location": "method", + "pattern": "^([a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]|[a-zA-Z0-9])$", + "minLength": 3, + "maxLength": 63 + } + } +} diff --git a/specification/redis/resource-manager/readme.md b/specification/redis/resource-manager/readme.md index c55685751c6c..16a4b8891c4e 100644 --- a/specification/redis/resource-manager/readme.md +++ b/specification/redis/resource-manager/readme.md @@ -29,6 +29,14 @@ openapi-type: arm tag: package-2023-04 ``` +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - Microsoft.Cache/preview/2023-05-01-preview/redis.json +``` ### Tag: package-2023-04 @@ -38,6 +46,7 @@ These settings apply only when `--tag=package-2023-04` is specified on the comma input-file: - Microsoft.Cache/stable/2023-04-01/redis.json ``` + ### Tag: package-2022-06 These settings apply only when `--tag=package-2022-06` is specified on the command line. From 85b43d51a8c41ffd83eedd3dec1f385396d5fbec Mon Sep 17 00:00:00 2001 From: Osahumen Uyi Aghasomwan <65305780+osaghaso@users.noreply.github.com> Date: Fri, 5 May 2023 10:36:21 -0700 Subject: [PATCH 28/79] Adding incoming call events to swagger (#23431) * adding incoming call * adding incoming call * adding incoming call event to Event grid * fixing avocado failure * fixing avocado failure * fixing build failures * fixing build failures * Revert "fixing build failures" This reverts commit 82b4ab3108ab8eca35ce20c391778c860ca25faf. * fixing build failures * Adding Incoming Call events to eventgrid swagger * Addressing comments * Adding Incoming Call events to eventgrid swagger * Adding Incoming Call events to eventgrid swagger * removing CallingCommunicationIdentifier * removing unwanted string * addressing comments * making custom context its own defination * making custom context its own defination * adding the CommunicationIdentifier to property * merging * merging --- .../AzureCommunicationServices.json | 59 +++++++++++++++++++ .../cloud-events-schema/incoming_call.json | 38 ++++++++++++ .../event-grid-schema/incoming_call.json | 39 ++++++++++++ 3 files changed, 136 insertions(+) create mode 100644 specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/incoming_call.json create mode 100644 specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/incoming_call.json diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index a4d87093ee38..4537bd6f6852 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -7,6 +7,41 @@ }, "paths": {}, "definitions": { + "AcsIncomingCallEventData": { + "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.IncomingCall event", + "properties": { + "to": { + "description": "The communication identifier of the target user.", + "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel", + "x-ms-client-name": "toCommunicationIdentifier" + }, + "from": { + "description": "The communication identifier of the user who initiated the call.", + "$ref": "../../../../../communication/data-plane/Common/stable/2021-03-07/common.json#/definitions/CommunicationIdentifierModel", + "x-ms-client-name": "fromCommunicationIdentifier" + }, + "serverCallId": { + "description": "The Id of the server call", + "type": "string" + }, + "callerDisplayName": { + "description": "Display name of caller.", + "type": "string" + }, + "customContext": { + "description": "Custom Context of Incoming Call", + "$ref": "#/definitions/AcsIncomingCallCustomContext" + }, + "incomingCallContext": { + "description": "Signed incoming call context.", + "type": "string" + }, + "correlationId": { + "description": "CorrelationId (CallId).", + "type": "string" + } + } + }, "AcsUserDisconnectedEventData": { "description": "Schema of the Data property of an EventGridEvent for an Microsoft.Communication.UserDisconnected event.", "properties": { @@ -861,6 +896,30 @@ "type": "string" } } + }, + "AcsIncomingCallCustomContext": { + "description": "Custom Context of Incoming Call", + "type": "object", + "properties": { + "customHeaders": { + "type": "string", + "description": "Custom Headers for incoming call" + }, + "sipHeaders": { + "type": "object", + "description": "Sip Headers for incoming call", + "additionalProperties": { + "type": "string" + } + }, + "voipHeaders": { + "type": "object", + "description": "Voip Headers for incoming call", + "additionalProperties": { + "type": "string" + } + } + } } } } diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/incoming_call.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/incoming_call.json new file mode 100644 index 000000000000..1908785a12fc --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/cloud-events-schema/incoming_call.json @@ -0,0 +1,38 @@ +{ + "id": "e80026e7-e298-46ba-bc42-dab0eda92581", + "source": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "/caller/{caller-id}/recipient/{recipient-id}", + "data": { + "to": { + "kind": "communicationUser", + "rawId": "{recipient-id}", + "communicationUser": { + "id": "{recipient-id}" + } + }, + "from": { + "kind": "communicationUser", + "rawId": "{caller-id}", + "communicationUser": { + "id": "{caller-id}" + } + }, + "serverCallId": "{server-call-id}", + "callerDisplayName": "VOIP Caller", + "customContext": { + "sipHeaders": { + "userToUser": "616d617a6f6e5f6368696;encoding=hex", + "X-MS-Custom-myheader1": "35567842", + "X-MS-Custom-myheader2": "customsipheadervalue" + }, + "voipHeaders": { + "customHeader": "customValue" + } + }, + "incomingCallContext": "{incoming-call-contextValue}", + "correlationId": "correlationId" + }, + "type": "Microsoft.Communication.IncomingCall", + "specversion": "1.0", + "time": "2023-04-04T17:18:42.5542219Z" +} diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/incoming_call.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/incoming_call.json new file mode 100644 index 000000000000..7531335623c5 --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/examples/event-grid-schema/incoming_call.json @@ -0,0 +1,39 @@ +{ + "id": "e80026e7-e298-46ba-bc42-dab0eda92581", + "topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}", + "subject": "/caller/{caller-id}/recipient/{recipient-id}", + "data": { + "to": { + "kind": "communicationUser", + "rawId": "{recipient-id}", + "communicationUser": { + "id": "{recipient-id}" + } + }, + "from": { + "kind": "communicationUser", + "rawId": "{caller-id}", + "communicationUser": { + "id": "{caller-id}" + } + }, + "serverCallId": "{server-call-id}", + "callerDisplayName": "VOIP Caller", + "customContext": { + "sipHeaders": { + "userToUser": "616d617a6f6e5f6368696;encoding=hex", + "X-MS-Custom-myheader1": "35567842", + "X-MS-Custom-myheader2": "customsipheadervalue" + }, + "voipHeaders": { + "customHeader": "customValue" + } + }, + "incomingCallContext": "{incoming-call-contextValue}", + "correlationId": "correlationId" + }, + "eventType": "Microsoft.Communication.IncomingCall", + "dataVersion": "1.0", + "metadataVersion": "1", + "eventTime": "2023-04-04T17:18:42.5542219Z" +} From e8e77656741d4e496c3ad267de463f0c0b83aa85 Mon Sep 17 00:00:00 2001 From: Arun Mohan Kumar <43769805+arunmk-ms@users.noreply.github.com> Date: Fri, 5 May 2023 10:40:31 -0700 Subject: [PATCH 29/79] EventGrid - AzureHealthcareApis swagger update for GA (#23592) * Update swagger for Dicom update events * Added partition to Dicom events * Added partition to subject * Renamed partition name to default --- .../stable/2018-01-01/HealthcareApis.json | 47 +++++++++++++++++++ .../dicom_image_created.json | 3 +- .../dicom_image_deleted.json | 3 +- .../dicom_image_updated.json | 16 +++++++ .../dicom_image_created.json | 3 +- .../dicom_image_deleted.json | 3 +- .../dicom_image_updated.json | 17 +++++++ 7 files changed, 88 insertions(+), 4 deletions(-) create mode 100644 specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_updated.json create mode 100644 specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_updated.json diff --git a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json index bb390c759724..0cee2c5ea41d 100644 --- a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json +++ b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/HealthcareApis.json @@ -92,6 +92,10 @@ "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageCreated event.", "type": "object", "properties": { + "partitionName": { + "description": "Data partition name", + "type": "string" + }, "imageStudyInstanceUid": { "description": "Unique identifier for the Study", "type": "string" @@ -123,10 +127,53 @@ } } }, + "HealthcareDicomImageUpdatedEventData": { + "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageUpdated event.", + "type": "object", + "properties": { + "partitionName": { + "description": "Data partition name", + "type": "string" + }, + "imageStudyInstanceUid": { + "description": "Unique identifier for the Study", + "type": "string" + }, + "imageSeriesInstanceUid": { + "description": "Unique identifier for the Series", + "type": "string" + }, + "imageSopInstanceUid": { + "description": "Unique identifier for the DICOM Image", + "type": "string" + }, + "serviceHostName": { + "description": "Domain name of the DICOM account for this image.", + "type": "string" + }, + "sequenceNumber": { + "description": "Sequence number of the DICOM Service within Azure Health Data Services. It is unique for every image creation, updation and deletion within the service.", + "type": "integer", + "format": "int64" + } + }, + "x-ms-examples": { + "DicomImageUpdatedCloudEventsSchema": { + "$ref": "./examples/cloud-events-schema/dicom_image_updated.json" + }, + "DicomImageUpdatedEventGridSchema": { + "$ref": "./examples/event-grid-schema/dicom_image_updated.json" + } + } + }, "HealthcareDicomImageDeletedEventData": { "description": "Schema of the Data property of an EventGridEvent for a Microsoft.HealthcareApis.DicomImageDeleted event.", "type": "object", "properties": { + "partitionName": { + "description": "Data partition name", + "type": "string" + }, "imageStudyInstanceUid": { "description": "Unique identifier for the Study", "type": "string" diff --git a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_created.json b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_created.json index 08e4c6bc2000..1f69f28c1218 100644 --- a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_created.json +++ b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_created.json @@ -1,10 +1,11 @@ { "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", - "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", "type": "Microsoft.HealthcareApis.DicomImageCreated", "time": "2022-09-15T01:14:04.5613214Z", "id": "d621839d-958b-4142-a638-bb966b4f7dfd", "data": { + "partitionName": "Microsoft.Default", "imageStudyInstanceUid": "1.2.3.4.3", "imageSeriesInstanceUid": "1.2.3.4.3.9423673", "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", diff --git a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_deleted.json b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_deleted.json index 3fbf68e70205..5fc2ab9ddce0 100644 --- a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_deleted.json +++ b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_deleted.json @@ -1,10 +1,11 @@ { "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", - "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", "type": "Microsoft.HealthcareApis.DicomImageDeleted", "time": "2022-09-15T01:14:04.5613214Z", "id": "eac1c1a0-ffa8-4b28-97cc-1d8b9a0a6021", "data": { + "partitionName": "Microsoft.Default", "imageStudyInstanceUid": "1.2.3.4.3", "imageSeriesInstanceUid": "1.2.3.4.3.9423673", "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", diff --git a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_updated.json b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_updated.json new file mode 100644 index 000000000000..112b7d49674f --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/cloud-events-schema/dicom_image_updated.json @@ -0,0 +1,16 @@ +{ + "source": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", + "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "type": "Microsoft.HealthcareApis.DicomImageUpdated", + "time": "2022-09-15T01:14:04.5613214Z", + "id": "7e8aca04-e815-4387-82a8-9fcf15a3114b", + "data": { + "partitionName": "Microsoft.Default", + "imageStudyInstanceUid": "1.2.3.4.3", + "imageSeriesInstanceUid": "1.2.3.4.3.9423673", + "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com", + "sequenceNumber": 1 + }, + "specversion": "1.0" +} diff --git a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_created.json b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_created.json index 13506e42f4f3..99422ee7e7cb 100644 --- a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_created.json +++ b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_created.json @@ -1,8 +1,9 @@ { "id": "d621839d-958b-4142-a638-bb966b4f7dfd", "topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", - "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", "data": { + "partitionName": "Microsoft.Default", "imageStudyInstanceUid": "1.2.3.4.3", "imageSeriesInstanceUid": "1.2.3.4.3.9423673", "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", diff --git a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_deleted.json b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_deleted.json index ef0421e155e6..3e6590b57f48 100644 --- a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_deleted.json +++ b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_deleted.json @@ -1,8 +1,9 @@ { "id": "eac1c1a0-ffa8-4b28-97cc-1d8b9a0a6021", "topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", - "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", "data": { + "partitionName": "Microsoft.Default", "imageStudyInstanceUid": "1.2.3.4.3", "imageSeriesInstanceUid": "1.2.3.4.3.9423673", "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", diff --git a/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_updated.json b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_updated.json new file mode 100644 index 000000000000..68678d63d2fb --- /dev/null +++ b/specification/eventgrid/data-plane/Microsoft.HealthcareApis/stable/2018-01-01/examples/event-grid-schema/dicom_image_updated.json @@ -0,0 +1,17 @@ +{ + "id": "7e8aca04-e815-4387-82a8-9fcf15a3114b", + "topic": "/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.HealthcareApis/workspaces/{workspace-name}", + "subject": "{dicom-account}.dicom.azurehealthcareapis.com/v1/partitions/Microsoft.Default/studies/1.2.3.4.3/series/1.2.3.4.3.9423673/instances/1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "data": { + "partitionName": "Microsoft.Default", + "imageStudyInstanceUid": "1.2.3.4.3", + "imageSeriesInstanceUid": "1.2.3.4.3.9423673", + "imageSopInstanceUid": "1.3.6.1.4.1.45096.2.296485376.2210.1633373143.864442", + "serviceHostName": "{dicom-account}.dicom.azurehealthcareapis.com", + "sequenceNumber": 1 + }, + "eventType": "Microsoft.HealthcareApis.DicomImageUpdated", + "dataVersion": "1", + "metadataVersion": "1", + "eventTime": "2022-09-15T01:14:04.5613214Z" +} From 72427ef3ff5875bd8409ef112ef5e6f3cf2b8795 Mon Sep 17 00:00:00 2001 From: gracewilcox <43627800+gracewilcox@users.noreply.github.com> Date: Fri, 5 May 2023 11:13:15 -0700 Subject: [PATCH 30/79] add descriptions to swagger (#23833) --- .../2022-10-27/OperationalInsights.json | 28 +++++++++++-------- 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json index a68d8910cfe2..6a13c2da4c35 100644 --- a/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json +++ b/specification/operationalinsights/data-plane/Microsoft.OperationalInsights/stable/2022-10-27/OperationalInsights.json @@ -87,7 +87,7 @@ "post": { "operationId": "Query_Execute", "summary": "Execute an Analytics query", - "description": "Executes an Analytics query for data. [Here](https://dev.loganalytics.io/documentation/Using-the-API) is an example for using POST with an Analytics query.", + "description": "Executes an Analytics query for data. [Here](https://learn.microsoft.com/azure/azure-monitor/logs/api/request-format) is an example for using POST with an Analytics query.", "x-ms-examples": { "simple-query": { "$ref": "examples/la-post-example.json" @@ -187,7 +187,7 @@ "get": { "operationId": "Query_ResourceGet", "summary": "Execute an Analytics query using resource URI", - "description": "Executes an Analytics query for data in the context of a resource. [Here](https://docs.microsoft.com/azure/azure-monitor/logs/api/azure-resource-queries) is an example for using POST with an Analytics query.", + "description": "Executes an Analytics query for data in the context of a resource. [Here](https://learn.microsoft.com/azure/azure-monitor/logs/api/azure-resource-queries) is an example for using POST with an Analytics query.", "x-ms-examples": { "simple-query": { "$ref": "examples/la-get-resource-centric-example.json" @@ -222,7 +222,7 @@ "post": { "operationId": "Query_ResourceExecute", "summary": "Execute an Analytics query using resource ID", - "description": "Executes an Analytics query for data in the context of a resource. [Here](https://docs.microsoft.com/azure/azure-monitor/logs/api/azure-resource-queries) is an example for using POST with an Analytics query.", + "description": "Executes an Analytics query for data in the context of a resource. [Here](https://learn.microsoft.com/azure/azure-monitor/logs/api/azure-resource-queries) is an example for using POST with an Analytics query.", "x-ms-examples": { "simple-query": { "$ref": "examples/la-post-resource-centric-example.json" @@ -259,7 +259,7 @@ "post": { "operationId": "Query_Batch", "summary": "Execute a batch of Analytics queries", - "description": "Executes a batch of Analytics queries for data. [Here](https://dev.loganalytics.io/documentation/Using-the-API) is an example for using POST with an Analytics query.", + "description": "Executes a batch of Analytics queries for data. [Here](https://learn.microsoft.com/azure/azure-monitor/logs/api/batch-queries) is an example for using POST with an Analytics query.", "x-ms-examples": { "metadataPost": { "$ref": "examples/batch-query-example.json" @@ -299,7 +299,7 @@ "get": { "operationId": "Query_ResourceGetXms", "summary": "Execute an Analytics query using resource URI", - "description": "Executes an Analytics query for data in the context of a resource. [Here](https://docs.microsoft.com/azure/azure-monitor/logs/api/azure-resource-queries) is an example for using POST with an Analytics query.", + "description": "Executes an Analytics query for data in the context of a resource. [Here](https://learn.microsoft.com/azure/azure-monitor/logs/api/azure-resource-queries) is an example for using POST with an Analytics query.", "x-ms-examples": { "simple-query": { "$ref": "examples/la-get-resource-centric-example.json" @@ -334,7 +334,7 @@ "post": { "operationId": "Query_ResourceExecuteXms", "summary": "Execute an Analytics query using resource ID", - "description": "Executes an Analytics query for data in the context of a resource. [Here](https://docs.microsoft.com/azure/azure-monitor/logs/api/azure-resource-queries) is an example for using POST with an Analytics query.", + "description": "Executes an Analytics query for data in the context of a resource. [Here](https://learn.microsoft.com/azure/azure-monitor/logs/api/azure-resource-queries) is an example for using POST with an Analytics query.", "x-ms-examples": { "simple-query": { "$ref": "examples/la-post-resource-centric-example.json" @@ -371,7 +371,7 @@ "parameters": { "workspaceId": { "name": "workspaceId", - "description": "ID of the workspace. This is Workspace ID from the Properties blade in the Azure portal.", + "description": "Primary Workspace ID of the query. This is the Workspace ID from the Properties blade in the Azure portal.", "in": "path", "required": true, "type": "string", @@ -461,7 +461,7 @@ "$ref": "#/definitions/timespanParam" }, "workspaces": { - "description": "A list of workspaces that are included in the query.", + "description": "A list of workspaces to query in addition to the primary workspace.", "$ref": "#/definitions/workspacesParam" } }, @@ -475,7 +475,7 @@ "type": "object", "properties": { "tables": { - "description": "The list of tables, columns and rows.", + "description": "The results of the query in tabular format.", "type": "array", "items": { "$ref": "#/definitions/table" @@ -1492,10 +1492,11 @@ "description": "An single request in a batch.", "properties": { "id": { - "description": "The error details.", + "description": "Unique ID corresponding to each request in the batch.", "type": "string" }, "headers": { + "description": "Headers of the request. Can use prefer header to set server timeout and to query statistics and visualization information.", "type": "object", "additionalProperties": { "type": "string" @@ -1505,6 +1506,7 @@ "$ref": "#/definitions/queryBody" }, "path": { + "description": "The query path of a single request in a batch, defaults to /query", "type": "string", "enum": [ "/query" @@ -1514,6 +1516,7 @@ } }, "method": { + "description": "The method of a single request in a batch, defaults to POST", "type": "string", "enum": [ "POST" @@ -1523,7 +1526,7 @@ } }, "workspace": { - "description": "Workspace Id to be included in the query", + "description": "Primary Workspace ID of the query. This is the Workspace ID from the Properties blade in the Azure portal.", "type": "string" } }, @@ -1547,6 +1550,7 @@ } }, "batchQueryResponse": { + "description": "Contains the batch query response and the headers, id, and status of the request", "type": "object", "properties": { "id": { @@ -1574,7 +1578,7 @@ "type": "object", "properties": { "tables": { - "description": "The list of tables, columns and rows.", + "description": "The results of the query in tabular format.", "type": "array", "items": { "$ref": "#/definitions/table" From f7725593a3b4ea90c8f919916a379ba62a1eddc1 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Fri, 5 May 2023 13:05:58 -0700 Subject: [PATCH 31/79] Update ContosoWidgetManager sample for TypeSpec compiler v0.43.0 (#23757) - Replace "zonedDateTime" with "utcDateTime" - Breaking change in TypeSpec compiler v0.43.0 - Update "output-file" to use config interpolation - Breaking change in @azure-tools/typspec-autorest v0.29.0 --- .../Contoso.WidgetManager.Shared/main.tsp | 4 ++-- .../contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml | 2 +- .../preview/2022-11-01-preview/widgets.json | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager.Shared/main.tsp b/specification/contosowidgetmanager/Contoso.WidgetManager.Shared/main.tsp index ce9d59382a69..68dc135bd136 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager.Shared/main.tsp +++ b/specification/contosowidgetmanager/Contoso.WidgetManager.Shared/main.tsp @@ -4,5 +4,5 @@ model FakedSharedModel { tag: string; @doc("The created date.") - createdDate: zonedDateTime; -} \ No newline at end of file + createdDate: utcDateTime; +} diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml b/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml index b0eb2c748105..13e629352572 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml +++ b/specification/contosowidgetmanager/Contoso.WidgetManager/tspconfig.yaml @@ -16,7 +16,7 @@ options: azure-resource-provider-folder: "./data-plane" emitter-output-dir: "{project-root}/.." examples-directory: "./examples" - output-file: widgets.json + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/widgets.json" "@azure-tools/typespec-python": emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" package-mode: "dataplane" diff --git a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json index b393eea7a3f8..545a9fd14613 100644 --- a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json +++ b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json @@ -48,7 +48,7 @@ "type": "string", "format": "uri", "description": "The link to the next page of items", - "x-typespec-name": "Rest.ResourceLocation" + "x-typespec-name": "TypeSpec.Rest.ResourceLocation" } }, "description": "Paged collection of Widget items", From 7288f3925475238b49920fc0784f658b59aaf63b Mon Sep 17 00:00:00 2001 From: Wes Haggard Date: Fri, 5 May 2023 14:51:39 -0700 Subject: [PATCH 32/79] Fix cost management examples with long paths (#23834) Reduces the file paths for the examples to not hit long path issues when working on windows. --- .../costmanagement.budgets.json | 18 +++++++++--------- ...countEA-AlertRule-ReservationIdFilter.json} | 0 ...-AlertRule-ReservedResourceTypeFilter.json} | 0 ...le.json => BillingAccountEA-AlertRule.json} | 0 ...Profile-AlertRule-ReservationIdFilter.json} | 0 ...-AlertRule-ReservedResourceTypeFilter.json} | 0 ...Rule.json => BillingProfile-AlertRule.json} | 0 ...ustomer-AlertRule-ReservationIdFilter.json} | 0 ...-AlertRule-ReservedResourceTypeFilter.json} | 0 ...-AlertRule.json => Customer-AlertRule.json} | 0 10 files changed, 9 insertions(+), 9 deletions(-) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/{CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter.json => BillingAccountEA-AlertRule-ReservationIdFilter.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/{CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json => BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/{CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule.json => BillingAccountEA-AlertRule.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/{CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservationIdFilter.json => BillingProfile-AlertRule-ReservationIdFilter.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/{CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservedResourceTypeFilter.json => BillingProfile-AlertRule-ReservedResourceTypeFilter.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/{CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule.json => BillingProfile-AlertRule.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/{CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservationIdFilter.json => Customer-AlertRule-ReservationIdFilter.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/{CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservedResourceTypeFilter.json => Customer-AlertRule-ReservedResourceTypeFilter.json} (100%) rename specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/{CreateOrUpdate-ReservationUtilization-Customer-AlertRule.json => Customer-AlertRule.json} (100%) diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json index bdecff29c10d..63801cc455f9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.budgets.json @@ -176,31 +176,31 @@ "$ref": "./examples/Budgets/CreateOrUpdate/Cost/CreateOrUpdate-Cost-Subscription-Budget.json" }, "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule.json" + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json" }, "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json" + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json" }, "CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter.json" + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json" }, "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule.json": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule.json" + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json" }, "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservedResourceTypeFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservedResourceTypeFilter.json" + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json" }, "CreateOrUpdate-ReservationUtilization-BillingProfileMCA-AlertRule-ReservationIdFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservationIdFilter.json" + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json" }, "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule.json": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule.json" + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json" }, "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservedResourceTypeFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservedResourceTypeFilter.json" + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json" }, "CreateOrUpdate-ReservationUtilization-CustomerCSP-AlertRule-ReservationIdFilter": { - "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservationIdFilter.json" + "$ref": "./examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json" } }, "parameters": [ diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservationIdFilter.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservationIdFilter.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule-ReservedResourceTypeFilter.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/CreateOrUpdate-ReservationUtilization-BillingAccountEA-AlertRule.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/EA/BillingAccountEA-AlertRule.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservationIdFilter.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservationIdFilter.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule-ReservedResourceTypeFilter.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule-ReservedResourceTypeFilter.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-BillingProfile-AlertRule.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/BillingProfile-AlertRule.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservationIdFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservationIdFilter.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservationIdFilter.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservedResourceTypeFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule-ReservedResourceTypeFilter.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule-ReservedResourceTypeFilter.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json similarity index 100% rename from specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/CreateOrUpdate-ReservationUtilization-Customer-AlertRule.json rename to specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/examples/Budgets/CreateOrUpdate/ReservationUtilization/MCA/Customer-AlertRule.json From 53240ebc58b3c4e99de723194032064db1d97e63 Mon Sep 17 00:00:00 2001 From: Shawn Fang <45607042+mssfang@users.noreply.github.com> Date: Fri, 5 May 2023 15:03:11 -0700 Subject: [PATCH 33/79] [Language] Remove non-GA DocumentDetectedLanguage object (#23805) * Remove DocumentDetectedLanguage object * apply the same changes to dev folder --- .../data-plane/Language/analyzetext.json | 22 +------------------ .../stable/2023-04-01/analyzetext.json | 22 +------------------ 2 files changed, 2 insertions(+), 42 deletions(-) diff --git a/dev/cognitiveservices/data-plane/Language/analyzetext.json b/dev/cognitiveservices/data-plane/Language/analyzetext.json index 430b85f28f0b..528bd0ea4ce6 100644 --- a/dev/cognitiveservices/data-plane/Language/analyzetext.json +++ b/dev/cognitiveservices/data-plane/Language/analyzetext.json @@ -2076,7 +2076,7 @@ "type": "array", "description": "Response by document", "items": { - "$ref": "#/definitions/ExtractedSummaryDocumentResultWithDetectedLanguage" + "$ref": "#/definitions/ExtractedSummaryDocumentResult" } } }, @@ -2114,17 +2114,6 @@ ] } }, - "ExtractedSummaryDocumentResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ExtractedSummaryDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, "ExtractedSummaryDocumentResult": { "type": "object", "properties": { @@ -2660,15 +2649,6 @@ } } }, - "DocumentDetectedLanguage": { - "type": "object", - "properties": { - "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." - } - } - }, "DocumentWarning": { "type": "object", "required": [ diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzetext.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzetext.json index 430b85f28f0b..528bd0ea4ce6 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzetext.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzetext.json @@ -2076,7 +2076,7 @@ "type": "array", "description": "Response by document", "items": { - "$ref": "#/definitions/ExtractedSummaryDocumentResultWithDetectedLanguage" + "$ref": "#/definitions/ExtractedSummaryDocumentResult" } } }, @@ -2114,17 +2114,6 @@ ] } }, - "ExtractedSummaryDocumentResultWithDetectedLanguage": { - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/ExtractedSummaryDocumentResult" - }, - { - "$ref": "#/definitions/DocumentDetectedLanguage" - } - ] - }, "ExtractedSummaryDocumentResult": { "type": "object", "properties": { @@ -2660,15 +2649,6 @@ } } }, - "DocumentDetectedLanguage": { - "type": "object", - "properties": { - "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." - } - } - }, "DocumentWarning": { "type": "object", "required": [ From 66e6396bd95416afd77df1720057ab290544b714 Mon Sep 17 00:00:00 2001 From: Mike Kistler Date: Fri, 5 May 2023 15:09:52 -0700 Subject: [PATCH 34/79] Fix topContributorCount to be optional with default of 10 (#23806) --- .../AnomalyDetector/multivariate/models.tsp | 6 ++---- .../data-plane/AnomalyDetector/stable/v1.1/openapi.json | 4 ++-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp b/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp index 1618555e8386..f69f05a364a1 100644 --- a/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp +++ b/specification/cognitiveservices/AnomalyDetector/multivariate/models.tsp @@ -129,11 +129,9 @@ to be detected. dataSource: url; @doc(""" -Number of top contributed -variables for one anomalous time stamp in the response. The default is -10. +Number of top contributed variables for one anomalous time stamp in the response. """) - topContributorCount: int32; + topContributorCount?: int32 = 10; @doc(""" Start date/time of data for detection, which should diff --git a/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json b/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json index 202c6b6a509c..4b1365f8fd47 100644 --- a/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json +++ b/specification/cognitiveservices/data-plane/AnomalyDetector/stable/v1.1/openapi.json @@ -936,7 +936,8 @@ "topContributorCount": { "type": "integer", "format": "int32", - "description": "Number of top contributed\nvariables for one anomalous time stamp in the response. The default is\n10." + "description": "Number of top contributed variables for one anomalous time stamp in the response.", + "default": 10 }, "startTime": { "type": "string", @@ -952,7 +953,6 @@ "description": "Detection request for batch inference. This is an asynchronous inference that\nwill need another API to get detection results.", "required": [ "dataSource", - "topContributorCount", "startTime", "endTime" ] From 3c639105c011765893db51cbb0dda056e34dc994 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Fri, 5 May 2023 16:37:42 -0700 Subject: [PATCH 35/79] Remove "postinstall: tsc" from package.json (#23837) - Causing pipeline failures due to build errors from scripts in openapi-alps repo - Added in #23763 to improve the experience on local dev machines --- package.json | 3 --- 1 file changed, 3 deletions(-) diff --git a/package.json b/package.json index 01c1ebce5241..c8b6184cdbd3 100644 --- a/package.json +++ b/package.json @@ -17,8 +17,5 @@ "prettier": "^2.8.8", "typescript": "~5.0.4" }, - "scripts": { - "postinstall": "tsc" - }, "private": true } From 07c55de803057861912799405580ea9d022853fc Mon Sep 17 00:00:00 2001 From: Peng Jiahui <46921893+Alancere@users.noreply.github.com> Date: Sat, 6 May 2023 16:39:42 +0800 Subject: [PATCH 36/79] [Go] config readme.go.md (#23841) --- specification/networkcloud/resource-manager/readme.go.md | 6 ++---- specification/networkcloud/resource-manager/readme.md | 2 +- 2 files changed, 3 insertions(+), 5 deletions(-) diff --git a/specification/networkcloud/resource-manager/readme.go.md b/specification/networkcloud/resource-manager/readme.go.md index a43eee9f495b..3d90d50aaddc 100644 --- a/specification/networkcloud/resource-manager/readme.go.md +++ b/specification/networkcloud/resource-manager/readme.go.md @@ -3,11 +3,9 @@ These settings apply only when `--go` is specified on the command line. ```yaml $(go) && $(track2) -azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION -namespace: networkcloud -module-name: sdk/resourcemanager/$(namespace)/arm$(namespace) +module-name: sdk/resourcemanager/networkcloud/armnetworkcloud module: github.com/Azure/azure-sdk-for-go/$(module-name) output-folder: $(go-sdk-folder)/$(module-name) -module-version: 1.0.0 +azure-arm: true ``` diff --git a/specification/networkcloud/resource-manager/readme.md b/specification/networkcloud/resource-manager/readme.md index b7653dc7cbd0..6c607ed0ae27 100644 --- a/specification/networkcloud/resource-manager/readme.md +++ b/specification/networkcloud/resource-manager/readme.md @@ -51,7 +51,7 @@ swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - - repo: azure-sdk-for-go-track2 + - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-resource-manager-schemas - repo: azure-cli-extensions From 7e48d5fab29e61ccc1aa99978fbef8a9f72127d9 Mon Sep 17 00:00:00 2001 From: evyatarweissMarketplace <131973441+evyatarweissMarketplace@users.noreply.github.com> Date: Mon, 8 May 2023 05:07:21 +0300 Subject: [PATCH 37/79] s360Items (#23812) --- .../stable/2021-03-03/examples/GetReviewsNotification.json | 2 +- .../2021-03-03/examples/GetReviewsNotificationsOperations.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotification.json b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotification.json index ee066f1a2f61..a36950498606 100644 --- a/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotification.json +++ b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotification.json @@ -3,7 +3,7 @@ "notification": "5654d099-303d-4196-9d79-0334246f9edb", "subscription": "5654d099-303d-4196-9d79-0334246f9edb", "principalId": "0b12389c-5e1d-4b67-880c-71d0d4a8d751", - "api-version": "03-03-2021" + "api-version": "2021-03-03" }, "responses": { "200": { diff --git a/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotificationsOperations.json b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotificationsOperations.json index 109c0d97d7fa..10475b3ca2c4 100644 --- a/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotificationsOperations.json +++ b/specification/marketplacenotifications/resource-manager/Microsoft.MarketplaceNotifications/stable/2021-03-03/examples/GetReviewsNotificationsOperations.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "03-03-2021" + "api-version": "2021-03-03" }, "responses": { "200": { From 17aa6a1314de5aafef059d9aa2229901df506e75 Mon Sep 17 00:00:00 2001 From: Pruthvidhar R Dhodda <60198385+pruthvidhodda@users.noreply.github.com> Date: Sun, 7 May 2023 19:15:42 -0700 Subject: [PATCH 38/79] Add "serviceName" to ListIngressGatewayCredentialsRequest (#23819) --- ...intsPostListIngressGatewayCredentials.json | 8 ++++-- .../stable/2023-03-15/hybridconnectivity.json | 26 +++++++++++++++++++ 2 files changed, 32 insertions(+), 2 deletions(-) diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListIngressGatewayCredentials.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListIngressGatewayCredentials.json index 430bf536e449..91394f088cd8 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListIngressGatewayCredentials.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/examples/EndpointsPostListIngressGatewayCredentials.json @@ -3,7 +3,10 @@ "resourceUri": "subscriptions/f5bcc1d9-23af-4ae9-aca1-041d0f593a63/resourceGroups/arcGroup/providers/Microsoft.ArcPlaceHolder/ProvisionedClusters/cluster0", "api-version": "2023-03-15", "endpointName": "default", - "expiresin": 10800 + "expiresin": 10800, + "ListCredentialsRequest": { + "serviceName": "SSH" + } }, "responses": { "200": { @@ -13,7 +16,8 @@ "namespaceNameSuffix": "servicebus.windows.net", "hybridConnectionName": "microsoft.arcplaceholder/provisionedclusters/000/1619989456957411072", "accessKey": "SharedAccessSignature sr=http%3A%2F%2Fazgnrelay-eastus-l1.servicebus.windows.net%2Fmicrosoft.provisionedcluster%hci", - "expiresOn": 1620000256 + "expiresOn": 1620000256, + "serviceConfigurationToken": "SSHvjqH=pTlKql=RtMGw/-k5VFBxSYHIiq5ZgbGFcLkNrDNz5fDsinCN2zkG" }, "ingress": { "hostname": "clusterhostname", diff --git a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json index a916a2e7bd29..bf12a1e1355c 100644 --- a/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json +++ b/specification/hybridconnectivity/resource-manager/Microsoft.HybridConnectivity/stable/2023-03-15/hybridconnectivity.json @@ -636,6 +636,14 @@ }, { "$ref": "#/parameters/AccessTokenExpirationParameter" + }, + { + "name": "ListIngressGatewayCredentialsRequest", + "in": "body", + "schema": { + "$ref": "#/definitions/ListIngressGatewayCredentialsRequest" + }, + "description": "Object of type ListIngressGatewayCredentialsRequest" } ], "responses": { @@ -1050,6 +1058,24 @@ } } } + }, + "ListIngressGatewayCredentialsRequest": { + "type": "object", + "description": "Represent ListIngressGatewayCredentials Request object.", + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service.", + "enum": [ + "SSH", + "WAC" + ], + "x-ms-enum": { + "name": "serviceName", + "modelAsString": true + } + } + } } }, "parameters": { From 838d71cd8ec2c033f4aaefe272fac01f2496cf68 Mon Sep 17 00:00:00 2001 From: GalGoldi72 <124780962+GalGoldi72@users.noreply.github.com> Date: Mon, 8 May 2023 05:58:23 +0300 Subject: [PATCH 39/79] Update readme (#23811) --- specification/security/resource-manager/readme.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index a24533198fce..8799345462c0 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -113,6 +113,17 @@ input-file: - Microsoft.Security/preview/2023-01-01-preview/securityOperators.json ``` +### Tag: package-preview-2023-02-only + +These settings apply only when `--tag=package-preview-2023-02-only` is specified on the command line. + +``` yaml $(tag) == 'package-preview-2023-02-only' +input-file: + - Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsBaselineRuleOperations.json + - Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsScanOperations.json + - Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsScanResultsOperations.json +``` + ### Tag: package-preview-2023-02 These settings apply only when `--tag=package-preview-2023-02` is specified on the command line. @@ -122,7 +133,7 @@ input-file: - Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsBaselineRuleOperations.json - Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsScanOperations.json - Microsoft.Security/preview/2023-02-01-preview/sqlVulnerabilityAssessmentsScanResultsOperations.json - - Microsoft.Security/preview/2023-02-01-preview/healthReports.json + - Microsoft.Security/preview/2023-02-01-preview/healthReports.json - Microsoft.Security/preview/2023-02-15-preview/sensitivitySettings.json ``` From da459cd725e11aa72e7fbc3b65d523b6e2b6453b Mon Sep 17 00:00:00 2001 From: Alfredo Santamaria Date: Sun, 7 May 2023 20:02:29 -0700 Subject: [PATCH 40/79] Service Fabric Managed Clusters - api version 2023-03-01-preview (#23718) * initial commit copy from 2023-02-01-preview * update specs * update examples --------- Co-authored-by: Alfredo Santamaria Gomez --- .../ApplicationDeleteOperation_example.json | 19 + .../ApplicationGetOperation_example.json | 59 + .../ApplicationListOperation_example.json | 27 + .../ApplicationPatchOperation_example.json | 66 + .../ApplicationPutOperation_example_max.json | 156 + .../ApplicationPutOperation_example_min.json | 79 + ...cationTypeNameDeleteOperation_example.json | 19 + ...plicationTypeNameGetOperation_example.json | 22 + ...licationTypeNameListOperation_example.json | 26 + ...icationTypeNamePatchOperation_example.json | 30 + ...plicationTypeNamePutOperation_example.json | 25 + ...ionTypeVersionDeleteOperation_example.json | 20 + ...cationTypeVersionGetOperation_example.json | 24 + ...ationTypeVersionListOperation_example.json | 28 + ...tionTypeVersionPatchOperation_example.json | 32 + ...cationTypeVersionPutOperation_example.json | 45 + .../examples/DeleteNodes_example.json | 24 + .../Long_running_operation_result.json | 13 + .../Long_running_operation_status_failed.json | 23 + ...ng_running_operation_status_succeeded.json | 19 + ...ManagedClusterDeleteOperation_example.json | 17 + .../ManagedClusterGetOperation_example.json | 74 + ...rListByResourceGroupOperation_example.json | 95 + ...erListBySubscriptionOperation_example.json | 94 + .../ManagedClusterPatchOperation_example.json | 109 + ...anagedClusterPutOperation_example_max.json | 414 +++ ...anagedClusterPutOperation_example_min.json | 122 + ...lusterVersionGetByEnvironment_example.json | 24 + .../ManagedClusterVersionGet_example.json | 23 + ...anagedClusterVersionListByEnvironment.json | 35 + .../ManagedClusterVersionList_example.json | 34 + .../NodeTypeDeleteOperation_example.json | 18 + .../NodeTypeGetOperation_example.json | 47 + .../NodeTypeListOperation_example.json | 93 + ...deTypePatchOperationAutoScale_example.json | 87 + .../NodeTypePatchOperation_example.json | 77 + ...NodeTypePutOperationAutoScale_example.json | 201 ++ ...deTypePutOperationCustomImage_example.json | 68 + ...ionCustomSharedGalleriesImage_example.json | 68 + ...TypePutOperationDedicatedHost_example.json | 92 + ...NodeTypePutOperationStateless_example.json | 114 + ...deTypePutOperationVmImagePlan_example.json | 92 + .../NodeTypePutOperation_example_max.json | 328 ++ .../NodeTypePutOperation_example_min.json | 77 + .../NodeTypeSkusListOperation_example.json | 71 + .../examples/Operations_example.json | 95 + .../examples/ReimageNodes_UD_example.json | 21 + .../examples/ReimageNodes_example.json | 24 + .../examples/RestartNodes_example.json | 24 + .../ServiceDeleteOperation_example.json | 20 + .../examples/ServiceGetOperation_example.json | 39 + .../ServiceListOperation_example.json | 40 + .../ServicePatchOperation_example.json | 77 + .../ServicePutOperation_example_max.json | 192 ++ .../ServicePutOperation_example_min.json | 60 + .../managedAzResiliencyStatusGet_example.json | 33 + .../managedUnsupportedVMSizesGet_example.json | 20 + ...managedUnsupportedVMSizesList_example.json | 175 ++ .../managedapplication.json | 2737 +++++++++++++++++ .../2023-03-01-preview/managedcluster.json | 2027 ++++++++++++ .../preview/2023-03-01-preview/nodetype.json | 1729 +++++++++++ .../resource-manager/readme.md | 13 +- 62 files changed, 10555 insertions(+), 1 deletion(-) create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNamePatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNamePutOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionPutOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/DeleteNodes_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_result.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_status_failed.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_status_succeeded.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionGet_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionListByEnvironment.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionList_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePatchOperationAutoScale_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationAutoScale_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationCustomImage_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationCustomSharedGalleriesImage_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationDedicatedHost_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationStateless_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationVmImagePlan_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeSkusListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Operations_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ReimageNodes_UD_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ReimageNodes_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/RestartNodes_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceDeleteOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceGetOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceListOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePatchOperation_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePutOperation_example_max.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePutOperation_example_min.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedAzResiliencyStatusGet_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedUnsupportedVMSizesGet_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedUnsupportedVMSizesList_example.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/managedapplication.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/managedcluster.json create mode 100644 specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/nodetype.json diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationDeleteOperation_example.json new file mode 100644 index 000000000000..48d232f3c0a9 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationDeleteOperation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2023-03-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/76053752-a423-4a80-b283-1dad1ba5f314?api-version=2023-03-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationGetOperation_example.json new file mode 100644 index 000000000000..12f284717a10 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationGetOperation_example.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationListOperation_example.json new file mode 100644 index 000000000000..790352cbb6c1 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationListOperation_example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPatchOperation_example.json new file mode 100644 index 000000000000..9cfc9f5a8c04 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPatchOperation_example.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2023-03-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPutOperation_example_max.json new file mode 100644 index 000000000000..b3b1e4c0c004 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPutOperation_example_max.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2023-03-01-preview", + "parameters": { + "location": "eastus", + "tags": { + "a": "b" + }, + "properties": { + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "myService": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Creating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/9c2ce367-47ea-43de-b69e-c5a423da4557?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPutOperation_example_min.json new file mode 100644 index 000000000000..a72a32bc5850 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationPutOperation_example_min.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2023-03-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myApp", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "parameters": { + "param1": "value1" + }, + "upgradePolicy": { + "applicationHealthPolicy": { + "considerWarningAsError": true, + "maxPercentUnhealthyDeployedApplications": 0, + "defaultServiceTypeHealthPolicy": { + "maxPercentUnhealthyServices": 0, + "maxPercentUnhealthyPartitionsPerService": 0, + "maxPercentUnhealthyReplicasPerPartition": 0 + }, + "serviceTypeHealthPolicyMap": { + "service1": { + "maxPercentUnhealthyReplicasPerPartition": 30, + "maxPercentUnhealthyPartitionsPerService": 30, + "maxPercentUnhealthyServices": 30 + } + } + }, + "rollingUpgradeMonitoringPolicy": { + "failureAction": "Rollback", + "healthCheckRetryTimeout": "00:10:00", + "healthCheckWaitDuration": "00:02:00", + "healthCheckStableDuration": "00:05:00", + "upgradeDomainTimeout": "00:15:00", + "upgradeTimeout": "01:00:00" + }, + "upgradeReplicaSetCheckTimeout": 3600, + "forceRestart": false, + "instanceCloseDelayDuration": 600, + "upgradeMode": "UnmonitoredAuto", + "recreateApplication": false + } + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5dce62ce-439b-47af-81d8-99ab14708e91?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp", + "name": "myCluster", + "properties": { + "provisioningState": "Updating", + "version": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json new file mode 100644 index 000000000000..fa8798991504 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameDeleteOperation_example.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2023-03-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/6a367b2d-9f60-4941-b886-e348ddcb4127?api-version=2023-03-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameGetOperation_example.json new file mode 100644 index 000000000000..83120dae5d36 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameGetOperation_example.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameListOperation_example.json new file mode 100644 index 000000000000..3d5aca9c5bd6 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNameListOperation_example.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNamePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNamePatchOperation_example.json new file mode 100644 index 000000000000..ccdad642bd43 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNamePatchOperation_example.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2023-03-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNamePutOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNamePutOperation_example.json new file mode 100644 index 000000000000..cff7e1468014 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeNamePutOperation_example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2023-03-01-preview", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType", + "name": "myAppType", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json new file mode 100644 index 000000000000..b6303a6d3ad0 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionDeleteOperation_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2023-03-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/28e62369-ed8c-4aba-8c05-ab7d6238cc3d?api-version=2023-03-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionGetOperation_example.json new file mode 100644 index 000000000000..5620cd79eaac --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionGetOperation_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionListOperation_example.json new file mode 100644 index 000000000000..380620dcaaca --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionListOperation_example.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json new file mode 100644 index 000000000000..828f3af42467 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionPatchOperation_example.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2023-03-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionPutOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionPutOperation_example.json new file mode 100644 index 000000000000..652f6d14cc7d --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ApplicationTypeVersionPutOperation_example.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationTypeName": "myAppType", + "version": "1.0", + "api-version": "2023-03-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Creating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/e2413c7e-d51b-40ac-8155-bc85bf8ae856?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applicationTypes/versions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applicationTypes/myAppType/versions/1.0", + "name": "1.0", + "properties": { + "provisioningState": "Updating", + "appPackageUrl": "http://fakelink.test.com/MyAppType" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/DeleteNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/DeleteNodes_example.json new file mode 100644 index 000000000000..850725c21545 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/DeleteNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_result.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_result.json new file mode 100644 index 000000000000..9dfe9977b007 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_result.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-03-01-preview", + "operationId": "00000000-0000-0000-0000-000000001234" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_status_failed.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_status_failed.json new file mode 100644 index 000000000000..20caa02c354f --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_status_failed.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-03-01-preview", + "operationId": "00000000-0000-0000-0000-000000001234" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000001234", + "startTime": "2022-01-03T23:58:02.2501337Z", + "endTime": "2022-01-04T00:13:03.2790951Z", + "percentComplete": 100.0, + "status": "Failed", + "error": { + "code": "-2146233029", + "message": "A task was canceled." + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_status_succeeded.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_status_succeeded.json new file mode 100644 index 000000000000..d4048f824e5b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Long_running_operation_status_succeeded.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-03-01-preview", + "operationId": "00000000-0000-0000-0000-000000001234" + }, + "responses": { + "200": { + "body": { + "name": "00000000-0000-0000-0000-000000001234", + "startTime": "2022-01-03T23:58:02.2501337Z", + "endTime": "2022-01-04T00:13:03.2790951Z", + "percentComplete": 100.0, + "status": "Succeeded" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterDeleteOperation_example.json new file mode 100644 index 000000000000..5e61e489789d --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterDeleteOperation_example.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2023-03-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterGetOperation_example.json new file mode 100644 index 000000000000..46a1d9a78059 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterGetOperation_example.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json new file mode 100644 index 000000000000..339156c2ba0b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterListByResourceGroupOperation_example.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster2", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json new file mode 100644 index 000000000000..2fb998da5071 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterListBySubscriptionOperation_example.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster2", + "name": "myCluster2", + "tags": {}, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502164040075\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "2747e469-b24e-4039-8a0a-46151419523f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster2", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPatchOperation_example.json new file mode 100644 index 000000000000..32626072196b --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPatchOperation_example.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2023-03-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": { + "a": "b" + }, + "sku": { + "name": "Standard" + }, + "etag": "W/\"636462502169240745\"", + "properties": { + "provisioningState": "Succeeded", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterCodeVersion": "7.1.168.9494", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave0", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19001, + "httpGatewayConnectionPort": 19081, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "http" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "false" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPutOperation_example_max.json new file mode 100644 index 000000000000..c2ffdcfc4f54 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPutOperation_example_max.json @@ -0,0 +1,414 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2023-03-01-preview", + "parameters": { + "location": "eastus", + "tags": {}, + "sku": { + "name": "Basic" + }, + "properties": { + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "dnsName": "myCluster", + "adminUserName": "vmadmin", + "adminPassword": "{vm-password}", + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "http", + "loadDistribution": "Default" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + }, + { + "name": "AllowARM", + "protocol": "*", + "sourcePortRange": "*", + "sourceAddressPrefix": "AzureResourceManager", + "destinationAddressPrefix": "*", + "destinationPortRange": "33500-33699", + "access": "allow", + "priority": 2002, + "direction": "inbound" + } + ], + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "zonalUpdateMode": "Fast", + "enableIpv6": true, + "publicIPPrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPPrefix", + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ], + "auxiliarySubnets": [ + { + "name": "testSubnet1", + "enableIpv6": true, + "privateEndpointNetworkPolicies": "enabled", + "privateLinkServiceNetworkPolicies": "enabled", + "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1" + } + ], + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2", + "usnorth" + ] + } + ], + "useCustomVnet": true + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Updating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp", + "loadDistribution": "Default" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + }, + { + "name": "AllowARM", + "protocol": "*", + "sourcePortRange": "*", + "sourceAddressPrefix": "AzureResourceManager", + "destinationAddressPrefix": "*", + "destinationPortRange": "33500-33699", + "access": "allow", + "priority": 2002, + "direction": "inbound" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "zonalUpdateMode": "Fast", + "enableIpv6": true, + "enableServicePublicIP": true, + "publicIPPrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPPrefix", + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ], + "auxiliarySubnets": [ + { + "name": "testSubnet1", + "enableIpv6": true, + "privateEndpointNetworkPolicies": "enabled", + "privateLinkServiceNetworkPolicies": "enabled", + "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1" + } + ], + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2", + "usnorth" + ] + } + ], + "useCustomVnet": true + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Creating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Manual", + "clusterCodeVersion": "7.1.168.9494", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [ + { + "frontendPort": 80, + "backendPort": 80, + "probePort": 80, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 443, + "backendPort": 443, + "probePort": 443, + "protocol": "http", + "probeProtocol": "http" + }, + { + "frontendPort": 10000, + "backendPort": 10000, + "probePort": 10000, + "protocol": "tcp", + "probeProtocol": "tcp", + "loadDistribution": "Default" + } + ], + "allowRdpAccess": true, + "networkSecurityRules": [ + { + "name": "TestName", + "protocol": "tcp", + "access": "allow", + "priority": 1010, + "direction": "inbound", + "sourcePortRanges": [ + "*" + ], + "destinationPortRanges": [ + "*" + ], + "sourceAddressPrefixes": [ + "*" + ], + "destinationAddressPrefixes": [ + "*" + ], + "description": "Test description" + }, + { + "name": "AllowARM", + "protocol": "*", + "sourcePortRange": "*", + "sourceAddressPrefix": "AzureResourceManager", + "destinationAddressPrefix": "*", + "destinationPortRange": "33500-33699", + "access": "allow", + "priority": 2002, + "direction": "inbound" + } + ], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ], + "addonFeatures": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "enableAutoOSUpgrade": true, + "applicationTypeVersionsCleanupPolicy": { + "maxUnusedVersionsToKeep": 3 + }, + "zonalResiliency": true, + "zonalUpdateMode": "Fast", + "enableIpv6": true, + "enableServicePublicIP": true, + "ipv6Address": "0000:0000:0000:0000:0000:0000:0000:0000", + "publicIPPrefixId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.Network/publicIPPrefixes/myPublicIPPrefix", + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ], + "auxiliarySubnets": [ + { + "name": "testSubnet1", + "enableIpv6": true, + "privateEndpointNetworkPolicies": "enabled", + "privateLinkServiceNetworkPolicies": "enabled", + "networkSecurityGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/networkSecurityGroups/sn1" + } + ], + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2", + "usnorth" + ] + } + ], + "useCustomVnet": true + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPutOperation_example_min.json new file mode 100644 index 000000000000..0d3a0688c824 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterPutOperation_example_min.json @@ -0,0 +1,122 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2023-03-01-preview", + "parameters": { + "location": "eastus", + "sku": { + "name": "Basic" + }, + "properties": { + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "dnsName": "myCluster", + "adminUserName": "vmadmin", + "adminPassword": "{vm-password}", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Updating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters", + "location": "eastus", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster", + "name": "myCluster", + "tags": {}, + "etag": "W/\"636462502169240745\"", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Creating", + "clusterId": "92584666-9889-4ae8-8d02-91902923d37f", + "clusterUpgradeMode": "Automatic", + "clusterUpgradeCadence": "Wave1", + "clusterState": "WaitingForNodes", + "dnsName": "myCluster", + "fqdn": "MyCluster.eastus.cloudapp.azure.com", + "clusterCertificateThumbprints": [ + "12599211F8F14C90AFA9532AD79A6F2CA1C00622" + ], + "clientConnectionPort": 19000, + "httpGatewayConnectionPort": 19080, + "loadBalancingRules": [], + "adminUserName": "vmadmin", + "fabricSettings": [ + { + "name": "ManagedIdentityTokenService", + "parameters": [ + { + "name": "IsEnabled", + "value": "true" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json new file mode 100644 index 000000000000..54a3643f7a32 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionGetByEnvironment_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "clusterVersion": "7.2.477.9590", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionGet_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionGet_example.json new file mode 100644 index 000000000000..d4e2a7fd0444 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionGet_example.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "clusterVersion": "7.2.477.9590", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionListByEnvironment.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionListByEnvironment.json new file mode 100644 index 000000000000..4fff0af5c1d5 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionListByEnvironment.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "environment": "Windows", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.457.9590", + "name": "7.2.457.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.457.9590" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + ] + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionList_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionList_example.json new file mode 100644 index 000000000000..e3bffec0688e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ManagedClusterVersionList_example.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.457.9590", + "name": "7.2.457.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.457.9590" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/environments/Windows/managedClusterVersions/7.2.477.9590", + "name": "7.2.477.9590", + "type": "Microsoft.ServiceFabric/locations/environments/managedClusterVersions", + "properties": { + "supportExpiryUtc": "2021-11-30T00:00:00", + "osType": "Windows", + "clusterCodeVersion": "7.2.477.9590" + } + } + ] + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeDeleteOperation_example.json new file mode 100644 index 000000000000..9457fa00bcda --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeDeleteOperation_example.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeGetOperation_example.json new file mode 100644 index 000000000000..635e8b130f1e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeGetOperation_example.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "FE", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/FE", + "name": "FE", + "tags": {}, + "properties": { + "isPrimary": true, + "dataDiskSizeGB": 100, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D2", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 5, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeListOperation_example.json new file mode 100644 index 000000000000..337efde6181a --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeListOperation_example.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/FE", + "name": "FE", + "tags": {}, + "sku": { + "name": "Standard_P0", + "tier": "Standard", + "capacity": 5 + }, + "properties": { + "isPrimary": true, + "dataDiskSizeGB": 100, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D2", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 5, + "isStateless": false + } + }, + { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePatchOperationAutoScale_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePatchOperationAutoScale_example.json new file mode 100644 index 000000000000..ff5e0eeb28bb --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePatchOperationAutoScale_example.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "tags": { + "a": "b" + }, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": { + "a": "b" + }, + "sku": { + "name": "Standard_S0", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Succeeded", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePatchOperation_example.json new file mode 100644 index 000000000000..00b5920e09e8 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePatchOperation_example.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationAutoScale_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationAutoScale_example.json new file mode 100644 index 000000000000..96101aabc4a5 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationAutoScale_example.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": -1, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S2", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "sku": { + "name": "Standard_S2", + "tier": "Standard", + "capacity": 10 + }, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": true, + "multiplePlacementGroups": true, + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationCustomImage_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationCustomImage_example.json new file mode 100644 index 000000000000..61b15248f76e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationCustomImage_example.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "vmSize": "Standard_D3", + "vmImageResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/galleries/myCustomImages/images/Win2019DC", + "vmInstanceCount": 10 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImageResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/galleries/myCustomImages/images/Win2019DC", + "vmInstanceCount": 10, + "isStateless": false + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImageResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/galleries/myCustomImages/images/Win2019DC", + "vmInstanceCount": 10, + "isStateless": false + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationCustomSharedGalleriesImage_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationCustomSharedGalleriesImage_example.json new file mode 100644 index 000000000000..1753a19d0816 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationCustomSharedGalleriesImage_example.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "vmSize": "Standard_D3", + "vmSharedGalleryImageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/sharedGalleries/35349201-a0b3-405e-8a23-9f1450984307-SFSHAREDGALLERY/images/TestNoProdContainerDImage/versions/latest", + "vmInstanceCount": 10 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmSharedGalleryImageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/sharedGalleries/35349201-a0b3-405e-8a23-9f1450984307-SFSHAREDGALLERY/images/TestNoProdContainerDImage/versions/latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmSharedGalleryImageId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/test-custom-image/providers/Microsoft.Compute/sharedGalleries/35349201-a0b3-405e-8a23-9f1450984307-SFSHAREDGALLERY/images/TestNoProdContainerDImage/versions/latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationDedicatedHost_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationDedicatedHost_example.json new file mode 100644 index 000000000000..6fbad7cbbe57 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationDedicatedHost_example.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D8s_v3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2019-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "zones": [ + "1" + ], + "hostGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testhostgroupRG/providers/Microsoft.Compute/hostGroups/testHostGroup" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D8s_v3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2019-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "zones": [ + "1" + ], + "hostGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testhostgroupRG/providers/Microsoft.Compute/hostGroups/testHostGroup", + "isStateless": false + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D8s_v3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2019-Datacenter", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "zones": [ + "1" + ], + "hostGroupId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testhostgroupRG/providers/Microsoft.Compute/hostGroups/testHostGroup", + "isStateless": false + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationStateless_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationStateless_example.json new file mode 100644 index 000000000000..bd8c3f715a18 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationStateless_example.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "useTempDataDisk": true, + "multiplePlacementGroups": true, + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "useTempDataDisk": true, + "multiplePlacementGroups": true, + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "useTempDataDisk": true, + "multiplePlacementGroups": true, + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationVmImagePlan_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationVmImagePlan_example.json new file mode 100644 index 000000000000..2688c13b95f0 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperationVmImagePlan_example.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "vmSize": "Standard_D3", + "vmImagePublisher": "testpublisher", + "vmImageOffer": "windows_2022_test", + "vmImageSku": "win_2022_test_20_10_gen2", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "vmImagePlan": { + "name": "win_2022_test_20_10_gen2", + "publisher": "testpublisher", + "product": "windows_2022_test" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "testpublisher", + "vmImageOffer": "windows_2022_test", + "vmImageSku": "win_2022_test_20_10_gen2", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmImagePlan": { + "name": "win_2022_test_20_10_gen2", + "publisher": "testpublisher", + "product": "windows_2022_test" + } + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "testpublisher", + "vmImageOffer": "windows_2022_test", + "vmImageSku": "win_2022_test_20_10_gen2", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false, + "vmImagePlan": { + "name": "win_2022_test_20_10_gen2", + "publisher": "testpublisher", + "product": "windows_2022_test" + } + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperation_example_max.json new file mode 100644 index 000000000000..1aee8cf83fc7 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperation_example_max.json @@ -0,0 +1,328 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "dataDiskLetter": "S", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "isSpotVM": true, + "useEphemeralOSDisk": true, + "spotRestoreTimeout": "PT30M", + "evictionPolicy": "Deallocate", + "enableOverProvisioning": false, + "multiplePlacementGroups": true, + "securityType": "TrustedLaunch", + "secureBootEnabled": true, + "enableNodePublicIP": true, + "natGatewayId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/natGateways/myNatGateway", + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + }, + "additionalDataDisks": [ + { + "lun": 1, + "diskType": "StandardSSD_LRS", + "diskSizeGB": 256, + "diskLetter": "F" + }, + { + "lun": 2, + "diskType": "Premium_LRS", + "diskSizeGB": 150, + "diskLetter": "G" + } + ], + "enableAcceleratedNetworking": true, + "frontendConfigurations": [ + { + "loadBalancerBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool", + "loadBalancerInboundNatPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool", + "applicationGatewayBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/applicationGateways/appgw-test/backendAddressPools/appgwBepoolTest" + } + ], + "useDefaultPublicLoadBalancer": true, + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmSetupActions": [ + "EnableContainers", + "EnableHyperV" + ] + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "dataDiskLetter": "S", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "isSpotVM": true, + "useEphemeralOSDisk": true, + "spotRestoreTimeout": "PT30M", + "evictionPolicy": "Deallocate", + "enableOverProvisioning": false, + "multiplePlacementGroups": true, + "securityType": "TrustedLaunch", + "secureBootEnabled": true, + "enableNodePublicIP": true, + "natGatewayId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/natGateways/myNatGateway", + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + }, + "additionalDataDisks": [ + { + "lun": 1, + "diskType": "StandardSSD_LRS", + "diskSizeGB": 256, + "diskLetter": "F" + }, + { + "lun": 2, + "diskType": "Premium_LRS", + "diskSizeGB": 150, + "diskLetter": "G" + } + ], + "enableAcceleratedNetworking": true, + "frontendConfigurations": [ + { + "loadBalancerBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool", + "loadBalancerInboundNatPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool", + "applicationGatewayBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/applicationGateways/appgw-test/backendAddressPools/appgwBepoolTest" + } + ], + "useDefaultPublicLoadBalancer": true, + "zones": [ + "1", + "2", + "3" + ], + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmSetupActions": [ + "EnableContainers", + "EnableHyperV" + ] + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "Premium_LRS", + "dataDiskLetter": "S", + "placementProperties": { + "HasSSD": "true", + "NodeColor": "green", + "SomeProperty": "5" + }, + "capacities": { + "ClientConnections": "65536" + }, + "vmSize": "Standard_DS3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "enableEncryptionAtHost": true, + "isStateless": true, + "isSpotVM": true, + "useEphemeralOSDisk": true, + "spotRestoreTimeout": "PT30M", + "evictionPolicy": "Deallocate", + "enableOverProvisioning": false, + "multiplePlacementGroups": true, + "securityType": "TrustedLaunch", + "secureBootEnabled": true, + "enableNodePublicIP": true, + "natGatewayId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/natGateways/myNatGateway", + "vmSecrets": [ + { + "sourceVault": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.KeyVault/vaults/myVault" + }, + "vaultCertificates": [ + { + "certificateStore": "My", + "certificateUrl": "https://myVault.vault.azure.net:443/secrets/myCert/ef1a31d39e1f46bca33def54b6cda54c" + } + ] + } + ], + "vmExtensions": [ + { + "name": "Microsoft.Azure.Geneva.GenevaMonitoring", + "properties": { + "autoUpgradeMinorVersion": true, + "enableAutomaticUpgrade": true, + "forceUpdateTag": "v.1.0", + "publisher": "Microsoft.Azure.Geneva", + "type": "GenevaMonitoring", + "typeHandlerVersion": "2.0", + "settings": {} + } + } + ], + "vmManagedIdentity": { + "userAssignedIdentities": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myIdentity2" + ] + }, + "additionalDataDisks": [ + { + "lun": 1, + "diskType": "StandardSSD_LRS", + "diskSizeGB": 256, + "diskLetter": "F" + }, + { + "lun": 2, + "diskType": "Premium_LRS", + "diskSizeGB": 150, + "diskLetter": "G" + } + ], + "enableAcceleratedNetworking": true, + "frontendConfigurations": [ + { + "loadBalancerBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/backendAddressPools/LoadBalancerBEAddressPool", + "loadBalancerInboundNatPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/loadBalancers/test-LB/inboundNatPools/LoadBalancerNATPool", + "applicationGatewayBackendAddressPoolId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/applicationGateways/appgw-test/backendAddressPools/appgwBepoolTest" + } + ], + "useDefaultPublicLoadBalancer": true, + "zones": [ + "1", + "2", + "3" + ], + "subnetId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resRg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "vmSetupActions": [ + "EnableContainers", + "EnableHyperV" + ] + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperation_example_min.json new file mode 100644 index 000000000000..ec2038f601e0 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypePutOperation_example_min.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "properties": { + "isPrimary": false, + "dataDiskSizeGB": 200, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10 + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Updating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + }, + "200": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedClusters/myCluster/nodeTypes/BE", + "name": "BE", + "tags": {}, + "properties": { + "provisioningState": "Creating", + "isPrimary": false, + "dataDiskSizeGB": 200, + "dataDiskType": "StandardSSD_LRS", + "placementProperties": {}, + "capacities": {}, + "vmSize": "Standard_D3", + "vmImagePublisher": "MicrosoftWindowsServer", + "vmImageOffer": "WindowsServer", + "vmImageSku": "2016-Datacenter-Server-Core", + "vmImageVersion": "latest", + "vmInstanceCount": 10, + "isStateless": false + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeSkusListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeSkusListOperation_example.json new file mode 100644 index 000000000000..1fc34e91c498 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/NodeTypeSkusListOperation_example.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S0", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 100, + "default": 1, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S1", + "tier": "Standard" + }, + "capacity": { + "minimum": 3, + "maximum": 300, + "default": 3, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S2", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 1000, + "default": 1, + "scaleType": "Automatic" + } + }, + { + "resourceType": "Microsoft.ServiceFabric/managedClusters/nodeTypes", + "sku": { + "name": "Standard_S3", + "tier": "Standard" + }, + "capacity": { + "minimum": 3, + "maximum": 1000, + "default": 3, + "scaleType": "Automatic" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Operations_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Operations_example.json new file mode 100644 index 000000000000..2bc930d3c3a2 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/Operations_example.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ServiceFabric/managedClusters/read", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Read Cluster", + "description": "Read any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/managedClusters/write", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Create or Update Cluster", + "description": "Create or Update any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/managedClusters/delete", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "managedClusters", + "operation": "Delete Cluster", + "description": "Delete any Cluster" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/read", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Read Node type", + "description": "Read any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/write", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Create or Update Node type", + "description": "Create or Update any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/delete", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Delete Node type", + "description": "Delete any Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/restart/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Restart nodes from Node type", + "description": "Restart nodes from Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/reimage/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Reimage nodes from Node type", + "description": "Reimage nodes from Node type" + } + }, + { + "name": "Microsoft.ServiceFabric/nodeTypes/deleteNode/action", + "display": { + "provider": "Microsoft ServiceFabric", + "resource": "nodeTypes", + "operation": "Delete nodes from Node type", + "description": "Delete nodes from Node type" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ReimageNodes_UD_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ReimageNodes_UD_example.json new file mode 100644 index 000000000000..c31f45c3d758 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ReimageNodes_UD_example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "updateType": "ByUpgradeDomain" + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ReimageNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ReimageNodes_example.json new file mode 100644 index 000000000000..850725c21545 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ReimageNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/RestartNodes_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/RestartNodes_example.json new file mode 100644 index 000000000000..850725c21545 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/RestartNodes_example.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "nodeTypeName": "BE", + "api-version": "2023-03-01-preview", + "parameters": { + "nodes": [ + "BE_0", + "BE_3" + ] + } + }, + "responses": { + "202": { + "headers": { + "Location": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationResults/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview", + "Azure-AsyncOperation": "http://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedClusterOperationStatus/1ca6e48d-70ca-4e43-b652-3b0522f64d67?api-version=2023-03-01-preview" + } + }, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceDeleteOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceDeleteOperation_example.json new file mode 100644 index 000000000000..ab08c90502a2 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceDeleteOperation_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2023-03-01-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/41fa5ef9-7f34-4c36-a730-93e0bb757d22?api-version=2023-03-01-preview" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceGetOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceGetOperation_example.json new file mode 100644 index 000000000000..aaf44fc1f48a --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceGetOperation_example.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "servicePlacementPolicies": [], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceListOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceListOperation_example.json new file mode 100644 index 000000000000..9373998a9946 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServiceListOperation_example.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low" + } + ], + "instanceCount": 1, + "servicePackageActivationMode": "SharedProcess" + } + } + ], + "nextLink": "" + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePatchOperation_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePatchOperation_example.json new file mode 100644 index 000000000000..d1d971ef104e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePatchOperation_example.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2023-03-01-preview", + "parameters": { + "tags": { + "a": "b" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Succeeded", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePutOperation_example_max.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePutOperation_example_max.json new file mode 100644 index 000000000000..09588545a28f --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePutOperation_example_max.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2023-03-01-preview", + "parameters": { + "location": "eastus", + "tags": { + "a": "b" + }, + "properties": { + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "serviceDnsName": "myservicednsname.myApp", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Creating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "serviceDnsName": "myservicednsname.myApp", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/2e633105-aadc-4928-9164-d76b974170a3?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "tags": { + "a": "b" + }, + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "placementConstraints": "NodeType==frontend", + "serviceTypeName": "myServiceType", + "serviceDnsName": "myservicednsname.myApp", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "serviceLoadMetrics": [ + { + "name": "metric1", + "weight": "Low", + "defaultLoad": 3 + } + ], + "correlationScheme": [ + { + "serviceName": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService1", + "scheme": "AlignedAffinity" + } + ], + "servicePlacementPolicies": [ + { + "type": "NonPartiallyPlaceService" + } + ], + "scalingPolicies": [ + { + "scalingMechanism": { + "kind": "ScalePartitionInstanceCount", + "maxInstanceCount": 9, + "minInstanceCount": 3, + "scaleIncrement": 2 + }, + "scalingTrigger": { + "kind": "AveragePartitionLoadTrigger", + "lowerLoadThreshold": 2.0, + "metricName": "metricName", + "scaleInterval": "00:01:00", + "upperLoadThreshold": 8.0 + } + } + ], + "defaultMoveCost": "Medium", + "instanceCount": 5, + "minInstanceCount": 3, + "minInstancePercentage": 30, + "servicePackageActivationMode": "SharedProcess" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePutOperation_example_min.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePutOperation_example_min.json new file mode 100644 index 000000000000..c403f5b7d02e --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/ServicePutOperation_example_min.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resRg", + "clusterName": "myCluster", + "applicationName": "myApp", + "serviceName": "myService", + "api-version": "2023-03-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Creating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Location": "http://10.91.140.224/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/operationResults/5bc615c3-6c5b-4593-80e1-008f55376ec7?api-version=2023-03-01-preview" + }, + "body": { + "type": "Microsoft.ServiceFabric/managedClusters/applications/services", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/resRg/providers/Microsoft.ServiceFabric/managedclusters/myCluster/applications/myApp/services/myService", + "name": "myService", + "properties": { + "provisioningState": "Updating", + "serviceKind": "Stateless", + "serviceTypeName": "myServiceType", + "partitionDescription": { + "partitionScheme": "Singleton" + }, + "instanceCount": 1 + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedAzResiliencyStatusGet_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedAzResiliencyStatusGet_example.json new file mode 100644 index 000000000000..07868c4bcbc8 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedAzResiliencyStatusGet_example.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "resourceGroup1", + "clusterName": "mycluster1", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "baseResourceStatus": [ + { + "resourceName": "mycluster1storage", + "resourceType": "Microsoft.Storage/storageaccounts", + "isZoneResilient": false + }, + { + "resourceName": "PublicIP-mycluster1", + "resourceType": "Microsoft.Network/publicIPAddress", + "isZoneResilient": false + }, + { + "resourceName": "Primary", + "resourceType": "Microsoft.Compute/virtualmachinescalesets", + "isZoneResilient": false + } + ], + "isClusterZoneResilient": false + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedUnsupportedVMSizesGet_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedUnsupportedVMSizesGet_example.json new file mode 100644 index 000000000000..fd89bb057c6f --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedUnsupportedVMSizesGet_example.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-03-01-preview", + "vmSize": "Standard_B1ls1" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1ls1", + "name": "Standard_B1ls1", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1ls1" + } + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedUnsupportedVMSizesList_example.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedUnsupportedVMSizesList_example.json new file mode 100644 index 000000000000..510ed8a8418d --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/examples/managedUnsupportedVMSizesList_example.json @@ -0,0 +1,175 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2023-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1ls1", + "name": "Standard_B1ls1", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1ls1" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1s", + "name": "Standard_B1s", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1s" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B1ms", + "name": "Standard_B1ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B1ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B2s", + "name": "Standard_B2s", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B2s" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B2ms", + "name": "Standard_B2ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B2ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B4ms", + "name": "Standard_B4ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B4ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_B8ms", + "name": "Standard_B8ms", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_B8ms" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A1_v2", + "name": "Standard_A1_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A1_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A2_v2", + "name": "Standard_A2_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A2_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A4_v2", + "name": "Standard_A4_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A4_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A8_v2", + "name": "Standard_A8_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A8_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A2m_v2", + "name": "Standard_A2m_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A2m_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A4m_v2", + "name": "Standard_A4m_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A4m_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A8m_v2", + "name": "Standard_A8m_v2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A8m_v2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A0", + "name": "Basic_A0", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A0" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A1", + "name": "Basic_A1", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A1" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A2", + "name": "Basic_A2", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A2" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A3", + "name": "Basic_A3", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A3" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Basic_A4", + "name": "Basic_A4", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Basic_A4" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.ServiceFabric/locations/eastus/managedVMSizes/Standard_A0", + "name": "Standard_A0", + "type": "Microsoft.ServiceFabric/locations/managedVMSizes", + "properties": { + "size": "Standard_A0" + } + } + ] + } + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/managedapplication.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/managedapplication.json new file mode 100644 index 000000000000..93589d40aa91 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/managedapplication.json @@ -0,0 +1,2737 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2023-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Get", + "summary": "Gets a Service Fabric managed application type name resource.", + "description": "Get a Service Fabric application type name resource created or in the process of being created in the Service Fabric managed cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type": { + "$ref": "./examples/ApplicationTypeNameGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application type name resource.", + "description": "Create or update a Service Fabric managed application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type name resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type": { + "$ref": "./examples/ApplicationTypeNamePutOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Update", + "summary": "Updates the tags of an application type resource of a given managed cluster.", + "description": "Updates the tags of an application type resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application type": { + "$ref": "./examples/ApplicationTypeNamePatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_Delete", + "summary": "Deletes a Service Fabric managed application type name resource.", + "description": "Delete a Service Fabric managed application type name resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type": { + "$ref": "./examples/ApplicationTypeNameDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes": { + "get": { + "tags": [ + "ApplicationType" + ], + "operationId": "ApplicationTypes_List", + "summary": "Gets the list of application type name resources created in the specified Service Fabric managed cluster resource.", + "description": "Gets all application type name resources created or in the process of being created in the Service Fabric managed cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application type name resources": { + "$ref": "./examples/ApplicationTypeNameListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions/{version}": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Get", + "summary": "Gets a Service Fabric managed application type version resource.", + "description": "Get a Service Fabric managed application type version resource created or in the process of being created in the Service Fabric managed application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application type version": { + "$ref": "./examples/ApplicationTypeVersionGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application type version resource.", + "description": "Create or update a Service Fabric managed application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application type version": { + "$ref": "./examples/ApplicationTypeVersionPutOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Update", + "summary": "Updates the tags of an application type version resource of a given managed cluster.", + "description": "Updates the tags of an application type version resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application type version resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application type version": { + "$ref": "./examples/ApplicationTypeVersionPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_Delete", + "summary": "Deletes a Service Fabric managed application type version resource.", + "description": "Delete a Service Fabric managed application type version resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/version" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application type version": { + "$ref": "./examples/ApplicationTypeVersionDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applicationTypes/{applicationTypeName}/versions": { + "get": { + "tags": [ + "ApplicationTypeVersion" + ], + "operationId": "ApplicationTypeVersions_ListByApplicationTypes", + "summary": "Gets the list of application type version resources created in the specified Service Fabric managed application type name resource.", + "description": "Gets all application type version resources created or in the process of being created in the Service Fabric managed application type name resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationTypeName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application type version resources": { + "$ref": "./examples/ApplicationTypeVersionListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationTypeVersionResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_Get", + "summary": "Gets a Service Fabric managed application resource.", + "description": "Get a Service Fabric managed application resource created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get an application": { + "$ref": "./examples/ApplicationGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Application" + ], + "operationId": "Applications_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed application resource.", + "description": "Create or update a Service Fabric managed application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put an application with minimum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_min.json" + }, + "Put an application with maximum parameters": { + "$ref": "./examples/ApplicationPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Application" + ], + "operationId": "Applications_Update", + "summary": "Updates the tags of an application resource of a given managed cluster.", + "description": "Updates the tags of an application resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The application resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch an application": { + "$ref": "./examples/ApplicationPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Application" + ], + "operationId": "Applications_Delete", + "summary": "Deletes a Service Fabric managed application resource.", + "description": "Delete a Service Fabric managed application resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete an application": { + "$ref": "./examples/ApplicationDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications": { + "get": { + "tags": [ + "Application" + ], + "operationId": "Applications_List", + "summary": "Gets the list of managed application resources created in the specified Service Fabric cluster resource.", + "description": "Gets all managed application resources created or in the process of being created in the Service Fabric cluster resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of application resources": { + "$ref": "./examples/ApplicationListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ApplicationResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services/{serviceName}": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_Get", + "summary": "Gets a Service Fabric managed service resource.", + "description": "Get a Service Fabric service resource created or in the process of being created in the Service Fabric managed application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a service": { + "$ref": "./examples/ServiceGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "Service" + ], + "operationId": "Services_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed service resource.", + "description": "Create or update a Service Fabric managed service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceResource" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a service with minimum parameters": { + "$ref": "./examples/ServicePutOperation_example_min.json" + }, + "Put a service with maximum parameters": { + "$ref": "./examples/ServicePutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "Services" + ], + "operationId": "Services_Update", + "summary": "Updates the tags of a service resource of a given managed cluster.", + "description": "Updates the tags of a service resource of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The service resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceUpdateParameters" + } + } + ], + "x-ms-examples": { + "Patch a service": { + "$ref": "./examples/ServicePatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "Service" + ], + "operationId": "Services_Delete", + "summary": "Deletes a Service Fabric managed service resource.", + "description": "Delete a Service Fabric managed service resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/serviceName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a service": { + "$ref": "./examples/ServiceDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedclusters/{clusterName}/applications/{applicationName}/services": { + "get": { + "tags": [ + "Service" + ], + "operationId": "Services_ListByApplications", + "summary": "Gets the list of service resources created in the specified Service Fabric managed application resource.", + "description": "Gets all service resources created or in the process of being created in the Service Fabric managed application resource.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/applicationName" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a list of service resources": { + "$ref": "./examples/ServiceListOperation_example.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ServiceResourceList" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "AddRemoveIncrementalNamedPartitionScalingMechanism": { + "type": "object", + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. Partition names are in the format '0','1'...'N-1'.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanism" + }, + { + "type": "object", + "description": "AddRemoveIncrementalNamedPartitionScalingMechanism" + } + ], + "x-ms-discriminator-value": "AddRemoveIncrementalNamedPartition", + "required": [ + "minPartitionCount", + "maxPartitionCount", + "scaleIncrement" + ], + "properties": { + "minPartitionCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of named partitions of the service." + }, + "maxPartitionCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of named partitions of the service." + }, + "scaleIncrement": { + "type": "integer", + "format": "int32", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "ApplicationHealthPolicy": { + "type": "object", + "description": "Defines a health policy used to evaluate the health of an application or one of its children entities.\n", + "required": [ + "considerWarningAsError", + "maxPercentUnhealthyDeployedApplications" + ], + "properties": { + "considerWarningAsError": { + "type": "boolean", + "description": "Indicates whether warnings are treated with the same severity as errors." + }, + "maxPercentUnhealthyDeployedApplications": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy deployed applications. Allowed values are Byte values from zero to 100.\nThe percentage represents the maximum tolerated percentage of deployed applications that can be unhealthy before the application is considered in error.\nThis is calculated by dividing the number of unhealthy deployed applications over the number of nodes where the application is currently deployed on in the cluster.\nThe computation rounds up to tolerate one failure on small numbers of nodes. Default percentage is zero.\n" + }, + "defaultServiceTypeHealthPolicy": { + "$ref": "#/definitions/ServiceTypeHealthPolicy", + "description": "The health policy used by default to evaluate the health of a service type." + }, + "serviceTypeHealthPolicyMap": { + "$ref": "#/definitions/ServiceTypeHealthPolicyMap", + "description": "The map with service type health policy per service type name. The map is empty by default." + } + } + }, + "ApplicationParameterList": { + "type": "object", + "description": "List of application parameters with overridden values from their default values specified in the application manifest.", + "additionalProperties": { + "type": "string" + } + }, + "ApplicationResource": { + "type": "object", + "description": "The application resource.", + "properties": { + "identity": { + "$ref": "#/definitions/ManagedIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationResourceList": { + "type": "object", + "description": "The list of application resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationResourceProperties": { + "type": "object", + "description": "The application resource properties.", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "version": { + "$ref": "#/definitions/ApplicationTypeVersion" + }, + "parameters": { + "$ref": "#/definitions/ApplicationParameterList" + }, + "upgradePolicy": { + "$ref": "#/definitions/ApplicationUpgradePolicy" + }, + "managedIdentities": { + "description": "List of user assigned identities for the application, each mapped to a friendly name.", + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationUserAssignedIdentity" + }, + "x-ms-identifiers": [] + } + } + }, + "ApplicationTypeResource": { + "type": "object", + "description": "The application type name resource", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeResourceList": { + "type": "object", + "description": "The list of application type names.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application type list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationTypeResourceProperties": { + "type": "object", + "description": "The application type name properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + } + } + }, + "ApplicationTypeUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application type update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application type update request" + }, + "ApplicationTypeVersion": { + "type": "string", + "description": "The version of the application type as defined in the application manifest.\nThis name must be the full Arm Resource ID for the referenced application type version.\n" + }, + "ApplicationTypeVersionResource": { + "type": "object", + "description": "An application type version resource for the specified application type name resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationTypeVersionResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ApplicationTypeVersionResourceList": { + "type": "object", + "description": "The list of application type version resources for the specified application type name resource.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationTypeVersionResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of application type version list results if there are any.", + "readOnly": true + } + } + }, + "ApplicationTypeVersionResourceProperties": { + "type": "object", + "description": "The properties of the application type version resource.", + "required": [ + "appPackageUrl" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "appPackageUrl": { + "type": "string", + "description": "The URL to the application package" + } + } + }, + "ApplicationTypeVersionUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application type version update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application type version update request" + }, + "ApplicationUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Application update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Application update request" + }, + "ApplicationUpgradePolicy": { + "type": "object", + "description": "Describes the policy for a monitored application upgrade.", + "properties": { + "applicationHealthPolicy": { + "$ref": "#/definitions/ApplicationHealthPolicy" + }, + "forceRestart": { + "$ref": "#/definitions/ForceRestart" + }, + "rollingUpgradeMonitoringPolicy": { + "$ref": "#/definitions/RollingUpgradeMonitoringPolicy" + }, + "instanceCloseDelayDuration": { + "type": "integer", + "format": "int64", + "description": "Duration in seconds, to wait before a stateless instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description." + }, + "upgradeMode": { + "$ref": "#/definitions/RollingUpgradeMode" + }, + "upgradeReplicaSetCheckTimeout": { + "type": "integer", + "format": "int64", + "description": "The maximum amount of time to block processing of an upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer)." + }, + "recreateApplication": { + "type": "boolean", + "description": "Determines whether the application should be recreated on update. If value=true, the rest of the upgrade policy parameters are not allowed." + } + } + }, + "ApplicationUserAssignedIdentity": { + "type": "object", + "required": [ + "name", + "principalId" + ], + "properties": { + "name": { + "type": "string", + "description": "The friendly name of user assigned identity." + }, + "principalId": { + "type": "string", + "description": "The principal id of user assigned identity." + } + } + }, + "AveragePartitionLoadScalingTrigger": { + "type": "object", + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTrigger" + }, + { + "type": "object", + "description": "AveragePartitionLoadScalingTrigger" + } + ], + "x-ms-discriminator-value": "AveragePartitionLoadTrigger", + "required": [ + "metricName", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleInterval" + ], + "properties": { + "metricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "scaleInterval": { + "type": "string", + "description": "The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format \"hh:mm:ss\"." + } + } + }, + "AverageServiceLoadScalingTrigger": { + "type": "object", + "description": "Represents a scaling policy related to an average load of a metric/resource of a service.", + "allOf": [ + { + "$ref": "#/definitions/ScalingTrigger" + }, + { + "type": "object", + "description": "AverageServiceLoadScalingTrigger" + } + ], + "x-ms-discriminator-value": "AverageServiceLoadTrigger", + "required": [ + "metricName", + "lowerLoadThreshold", + "upperLoadThreshold", + "scaleInterval", + "useOnlyPrimaryLoad" + ], + "properties": { + "metricName": { + "type": "string", + "description": "The name of the metric for which usage should be tracked." + }, + "lowerLoadThreshold": { + "type": "number", + "format": "double", + "description": "The lower limit of the load below which a scale in operation should be performed." + }, + "upperLoadThreshold": { + "type": "number", + "format": "double", + "description": "The upper limit of the load beyond which a scale out operation should be performed." + }, + "scaleInterval": { + "type": "string", + "description": "The period in seconds on which a decision is made whether to scale or not. This property should come in ISO 8601 format \"hh:mm:ss\"." + }, + "useOnlyPrimaryLoad": { + "type": "boolean", + "description": "Flag determines whether only the load of primary replica should be considered for scaling. If set to true, then trigger will only consider the load of primary replicas of stateful service. If set to false, trigger will consider load of all replicas. This parameter cannot be set to true for stateless service." + } + } + }, + "CorrelationSchemeList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceCorrelation" + }, + "x-ms-identifiers": [ + "serviceName" + ], + "description": "A list that describes the correlation of the service with other services." + }, + "ForceRestart": { + "type": "boolean", + "description": "If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).", + "default": false + }, + "HealthCheckRetryTimeout": { + "type": "string", + "description": "The amount of time to retry health evaluation when the application or cluster is unhealthy before FailureAction is executed. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "HealthCheckStableDuration": { + "type": "string", + "description": "The amount of time that the application or cluster must remain healthy before the upgrade proceeds to the next upgrade domain. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "HealthCheckWaitDuration": { + "type": "string", + "description": "The amount of time to wait after completing an upgrade domain before applying health policies. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "ManagedIdentity": { + "type": "object", + "description": "Describes the managed identities for an Azure resource.", + "properties": { + "principalId": { + "type": "string", + "readOnly": true, + "description": "The principal id of the managed identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "type": "string", + "readOnly": true, + "description": "The tenant id of the managed identity. This property will only be provided for a system assigned identity." + }, + "type": { + "$ref": "#/definitions/ManagedIdentityType" + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentityMap" + } + } + }, + "ManagedIdentityType": { + "type": "string", + "description": "The type of managed identity for the resource.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": false, + "values": [ + { + "value": "None", + "description": "Indicates that no identity is associated with the resource." + }, + { + "value": "SystemAssigned", + "description": "Indicates that system assigned identity is associated with the resource." + }, + { + "value": "UserAssigned", + "description": "Indicates that user assigned identity is associated with the resource." + }, + { + "value": "SystemAssigned, UserAssigned", + "description": "Indicates that both system assigned and user assigned identity are associated with the resource." + } + ] + } + }, + "MoveCost": { + "type": "string", + "description": "Specifies the move cost for the service.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "MoveCost", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Zero move cost. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the move cost of the service as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the move cost of the service as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the move cost of the service as High. The value is 3." + } + ] + } + }, + "NamedPartitionScheme": { + "type": "object", + "description": "Describes the named partition scheme of the service.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "NamedPartitionScheme" + } + ], + "x-ms-discriminator-value": "Named", + "required": [ + "names" + ], + "properties": { + "names": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Array for the names of the partitions." + } + } + }, + "Partition": { + "type": "object", + "discriminator": "partitionScheme", + "description": "Describes how the service is partitioned.", + "required": [ + "partitionScheme" + ], + "properties": { + "partitionScheme": { + "$ref": "#/definitions/PartitionScheme", + "description": "Specifies how the service is partitioned." + } + } + }, + "PartitionInstanceCountScaleMechanism": { + "type": "object", + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition.", + "allOf": [ + { + "$ref": "#/definitions/ScalingMechanism" + }, + { + "type": "object", + "description": "PartitionInstanceCountScaleMechanism" + } + ], + "x-ms-discriminator-value": "ScalePartitionInstanceCount", + "required": [ + "minInstanceCount", + "maxInstanceCount", + "scaleIncrement" + ], + "properties": { + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of instances of the partition." + }, + "maxInstanceCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of instances of the partition." + }, + "scaleIncrement": { + "type": "integer", + "format": "int32", + "description": "The number of instances to add or remove during a scaling operation." + } + } + }, + "PartitionScheme": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "Singleton", + "UniformInt64Range", + "Named" + ], + "x-ms-enum": { + "name": "PartitionScheme", + "modelAsString": true, + "values": [ + { + "value": "Singleton", + "description": "Indicates that the partition is based on string names, and is a SingletonPartitionScheme object, The value is 0." + }, + { + "value": "UniformInt64Range", + "description": "Indicates that the partition is based on Int64 key ranges, and is a UniformInt64RangePartitionScheme object. The value is 1." + }, + { + "value": "Named", + "description": "Indicates that the partition is based on string names, and is a NamedPartitionScheme object. The value is 2." + } + ] + } + }, + "ProxyResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Resource location depends on the parent resource.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Azure resource tags.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "RollingUpgradeMode": { + "type": "string", + "description": "The mode used to monitor health during a rolling upgrade. The values are Monitored, and UnmonitoredAuto.", + "enum": [ + "Monitored", + "UnmonitoredAuto" + ], + "x-ms-enum": { + "name": "RollingUpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Monitored", + "description": "The upgrade will stop after completing each upgrade domain and automatically monitor health before proceeding. The value is 0." + }, + { + "value": "UnmonitoredAuto", + "description": "The upgrade will proceed automatically without performing any health monitoring. The value is 1." + } + ] + } + }, + "RollingUpgradeMonitoringPolicy": { + "type": "object", + "description": "The policy used for monitoring the application upgrade", + "required": [ + "failureAction", + "healthCheckWaitDuration", + "healthCheckStableDuration", + "healthCheckRetryTimeout", + "upgradeTimeout", + "upgradeDomainTimeout" + ], + "properties": { + "failureAction": { + "type": "string", + "description": "The compensating action to perform when a Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode.", + "enum": [ + "Rollback", + "Manual" + ], + "x-ms-enum": { + "name": "FailureAction", + "modelAsString": true, + "values": [ + { + "value": "Rollback", + "description": "Indicates that a rollback of the upgrade will be performed by Service Fabric if the upgrade fails." + }, + { + "value": "Manual", + "description": "Indicates that a manual repair will need to be performed by the administrator if the upgrade fails. Service Fabric will not proceed to the next upgrade domain automatically." + } + ] + } + }, + "healthCheckWaitDuration": { + "$ref": "#/definitions/HealthCheckWaitDuration" + }, + "healthCheckStableDuration": { + "$ref": "#/definitions/HealthCheckStableDuration" + }, + "healthCheckRetryTimeout": { + "$ref": "#/definitions/HealthCheckRetryTimeout" + }, + "upgradeTimeout": { + "$ref": "#/definitions/UpgradeTimeout" + }, + "upgradeDomainTimeout": { + "$ref": "#/definitions/UpgradeDomainTimeout" + } + } + }, + "ScalingMechanism": { + "type": "object", + "discriminator": "kind", + "description": "Describes the mechanism for performing a scaling operation.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ServiceScalingMechanismKind", + "description": "Specifies the mechanism associated with this scaling policy." + } + } + }, + "ScalingPolicy": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "scalingMechanism", + "scalingTrigger" + ], + "properties": { + "scalingMechanism": { + "$ref": "#/definitions/ScalingMechanism", + "description": "Specifies the mechanism associated with this scaling policy" + }, + "scalingTrigger": { + "$ref": "#/definitions/ScalingTrigger", + "description": "Specifies the trigger associated with this scaling policy." + } + } + }, + "ScalingPolicyList": { + "type": "array", + "items": { + "$ref": "#/definitions/ScalingPolicy" + }, + "x-ms-identifiers": [], + "description": "Scaling policies for this service." + }, + "ScalingTrigger": { + "type": "object", + "discriminator": "kind", + "description": "Describes the trigger for performing a scaling operation.", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/ServiceScalingTriggerKind", + "description": "Specifies the trigger associated with this scaling policy." + } + } + }, + "ServiceCorrelation": { + "type": "object", + "description": "Creates a particular correlation between services.", + "required": [ + "scheme", + "serviceName" + ], + "properties": { + "scheme": { + "$ref": "#/definitions/ServiceCorrelationScheme", + "description": "The ServiceCorrelationScheme which describes the relationship between this service and the service specified via ServiceName." + }, + "serviceName": { + "$ref": "#/definitions/ServiceName", + "description": "The Arm Resource ID of the service that the correlation relationship is established with." + } + } + }, + "ServiceCorrelationScheme": { + "type": "string", + "description": "The service correlation scheme.", + "enum": [ + "AlignedAffinity", + "NonAlignedAffinity" + ], + "x-ms-enum": { + "name": "ServiceCorrelationScheme", + "modelAsString": true, + "values": [ + { + "value": "AlignedAffinity", + "description": "Aligned affinity ensures that the primaries of the partitions of the affinitized services are collocated on the same nodes. This is the default and is the same as selecting the Affinity scheme. The value is 0." + }, + { + "value": "NonAlignedAffinity", + "description": "Non-Aligned affinity guarantees that all replicas of each service will be placed on the same nodes. Unlike Aligned Affinity, this does not guarantee that replicas of particular role will be collocated. The value is 1." + } + ] + } + }, + "ServiceKind": { + "type": "string", + "description": "The kind of service (Stateless or Stateful).", + "enum": [ + "Stateless", + "Stateful" + ], + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true, + "values": [ + { + "value": "Stateless", + "description": "Does not use Service Fabric to make its state highly available or reliable. The value is 0." + }, + { + "value": "Stateful", + "description": "Uses Service Fabric to make its state or part of its state highly available and reliable. The value is 1." + } + ] + } + }, + "ServiceLoadMetric": { + "type": "object", + "description": "Specifies a metric to load balance a service during runtime.", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the metric. If the service chooses to report load during runtime, the load metric name should match the name that is specified in Name exactly. Note that metric names are case sensitive." + }, + "weight": { + "$ref": "#/definitions/ServiceLoadMetricWeight", + "description": "The service load metric relative weight, compared to other metrics configured for this service, as a number." + }, + "primaryDefaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Primary replica." + }, + "secondaryDefaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateful services. The default amount of load, as a number, that this service creates for this metric when it is a Secondary replica." + }, + "defaultLoad": { + "type": "integer", + "format": "int32", + "description": "Used only for Stateless services. The default amount of load, as a number, that this service creates for this metric." + } + } + }, + "ServiceLoadMetricsList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceLoadMetric" + }, + "x-ms-identifiers": [], + "description": "The service load metrics is given as an array of ServiceLoadMetric objects." + }, + "ServiceLoadMetricWeight": { + "type": "string", + "description": "Determines the metric weight relative to the other metrics that are configured for this service. During runtime, if two metrics end up in conflict, the Cluster Resource Manager prefers the metric with the higher weight.", + "enum": [ + "Zero", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "ServiceLoadMetricWeight", + "modelAsString": true, + "values": [ + { + "value": "Zero", + "description": "Disables resource balancing for this metric. This value is zero." + }, + { + "value": "Low", + "description": "Specifies the metric weight of the service load as Low. The value is 1." + }, + { + "value": "Medium", + "description": "Specifies the metric weight of the service load as Medium. The value is 2." + }, + { + "value": "High", + "description": "Specifies the metric weight of the service load as High. The value is 3." + } + ] + } + }, + "ServiceName": { + "type": "string", + "description": "The full ARM Resource ID describing the service resource", + "x-sf-clientlib": { + "typeName": "ServiceName" + } + }, + "ServicePlacementInvalidDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where a particular fault or upgrade domain should not be used for placement of the instances or replicas of that service.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementInvalidDomainPolicy" + } + ], + "x-ms-discriminator-value": "InvalidDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should not be used for placement." + } + } + }, + "ServicePlacementNonPartiallyPlaceServicePolicy": { + "type": "object", + "description": "The name of the domain that should used for placement as per this policy.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementNonPartiallyPlaceServicePolicy" + } + ], + "x-ms-discriminator-value": "NonPartiallyPlaceService" + }, + "ServicePlacementPoliciesList": { + "type": "array", + "items": { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + "x-ms-identifiers": [], + "description": "A list that describes the correlation of the service with other services." + }, + "ServicePlacementPolicy": { + "type": "object", + "discriminator": "type", + "description": "Describes the policy to be used for placement of a Service Fabric service.", + "required": [ + "type" + ], + "properties": { + "type": { + "$ref": "#/definitions/ServicePlacementPolicyType" + } + } + }, + "ServicePlacementPolicyType": { + "type": "string", + "description": "The type of placement policy for a service fabric service. Following are the possible values.", + "enum": [ + "InvalidDomain", + "RequiredDomain", + "PreferredPrimaryDomain", + "RequiredDomainDistribution", + "NonPartiallyPlaceService" + ], + "x-ms-enum": { + "name": "ServicePlacementPolicyType", + "modelAsString": true, + "values": [ + { + "value": "InvalidDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementInvalidDomainPolicyDescription, which indicates that a particular fault or upgrade domain cannot be used for placement of this service. The value is 0." + }, + { + "value": "RequiredDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription indicating that the replicas of the service must be placed in a specific domain. The value is 1." + }, + { + "value": "PreferredPrimaryDomain", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementPreferPrimaryDomainPolicyDescription, which indicates that if possible the Primary replica for the partitions of the service should be located in a particular domain as an optimization. The value is 2." + }, + { + "value": "RequiredDomainDistribution", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementRequireDomainDistributionPolicyDescription, indicating that the system will disallow placement of any two replicas from the same partition in the same domain at any time. The value is 3." + }, + { + "value": "NonPartiallyPlaceService", + "description": "Indicates that the ServicePlacementPolicyDescription is of type ServicePlacementNonPartiallyPlaceServicePolicyDescription, which indicates that if possible all replicas of a particular partition of the service should be placed atomically. The value is 4." + } + ] + } + }, + "ServicePlacementPreferPrimaryDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where the service's \nPrimary replicas should optimally be placed in a particular domain.\n\nThis placement policy is usually used with fault domains in scenarios where the Service Fabric\ncluster is geographically distributed in order to indicate that a service's primary replica should\nbe located in a particular fault domain, which in geo-distributed scenarios usually aligns with regional\nor datacenter boundaries. Note that since this is an optimization it is possible that the Primary replica\nmay not end up located in this domain due to failures, capacity limits, or other constraints.\n", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementPreferPrimaryDomainPolicy" + } + ], + "x-ms-discriminator-value": "PreferredPrimaryDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicePlacementRequiredDomainPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where the instances or replicas of that service must be placed in a particular domain.", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementRequiredDomainPolicy" + } + ], + "x-ms-discriminator-value": "RequiredDomain", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServicePlacementRequireDomainDistributionPolicy": { + "type": "object", + "description": "Describes the policy to be used for placement of a Service Fabric service where two replicas\nfrom the same partition should never be placed in the same fault or upgrade domain.\n\nWhile this is not common it can expose the service to an increased risk of concurrent failures\ndue to unplanned outages or other cases of subsequent/concurrent failures. As an example, consider\na case where replicas are deployed across different data center, with one replica per location.\nIn the event that one of the datacenters goes offline, normally the replica that was placed in that\ndatacenter will be packed into one of the remaining datacenters. If this is not desirable then this\npolicy should be set.\n", + "allOf": [ + { + "$ref": "#/definitions/ServicePlacementPolicy" + }, + { + "type": "object", + "description": "ServicePlacementRequireDomainDistributionPolicy" + } + ], + "x-ms-discriminator-value": "RequiredDomainDistribution", + "required": [ + "domainName" + ], + "properties": { + "domainName": { + "type": "string", + "description": "The name of the domain that should used for placement as per this policy." + } + } + }, + "ServiceResource": { + "type": "object", + "description": "The service resource.", + "properties": { + "properties": { + "$ref": "#/definitions/ServiceResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ] + }, + "ServiceResourceList": { + "type": "object", + "description": "The list of service resources.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceResource" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of service list results if there are any.", + "readOnly": true + } + } + }, + "ServiceResourceProperties": { + "type": "object", + "description": "The service resource properties.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourcePropertiesBase" + } + ], + "required": [ + "serviceKind", + "serviceTypeName", + "partitionDescription" + ], + "discriminator": "serviceKind", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response" + }, + "serviceKind": { + "$ref": "#/definitions/ServiceKind" + }, + "serviceTypeName": { + "type": "string", + "description": "The name of the service type" + }, + "partitionDescription": { + "$ref": "#/definitions/Partition" + }, + "servicePackageActivationMode": { + "type": "string", + "description": "The activation Mode of the service package", + "enum": [ + "SharedProcess", + "ExclusiveProcess" + ], + "x-ms-enum": { + "name": "ServicePackageActivationMode", + "modelAsString": true, + "values": [ + { + "value": "SharedProcess", + "description": "Indicates the application package activation mode will use shared process." + }, + { + "value": "ExclusiveProcess", + "description": "Indicates the application package activation mode will use exclusive process." + } + ] + } + }, + "serviceDnsName": { + "type": "string", + "description": "Dns name used for the service. If this is specified, then the DNS name can be used to return the IP addresses of service endpoints for application layer protocols (e.g., HTTP).\nWhen updating serviceDnsName, old name may be temporarily resolvable. However, rely on new name.\nWhen removing serviceDnsName, removed name may temporarily be resolvable. Do not rely on the name being unresolvable.\n" + } + } + }, + "ServiceResourcePropertiesBase": { + "type": "object", + "description": "The common service resource properties.", + "properties": { + "placementConstraints": { + "type": "string", + "description": "The placement constraints as a string. Placement constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: \"NodeColor == blue)\"." + }, + "correlationScheme": { + "$ref": "#/definitions/CorrelationSchemeList" + }, + "serviceLoadMetrics": { + "$ref": "#/definitions/ServiceLoadMetricsList" + }, + "servicePlacementPolicies": { + "$ref": "#/definitions/ServicePlacementPoliciesList" + }, + "defaultMoveCost": { + "$ref": "#/definitions/MoveCost" + }, + "scalingPolicies": { + "$ref": "#/definitions/ScalingPolicyList" + } + } + }, + "ServiceScalingMechanismKind": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "ScalePartitionInstanceCount", + "AddRemoveIncrementalNamedPartition" + ], + "x-ms-enum": { + "name": "ServiceScalingMechanismKind", + "modelAsString": true, + "values": [ + { + "value": "ScalePartitionInstanceCount", + "description": "Represents a scaling mechanism for adding or removing instances of stateless service partition. The value is 0." + }, + { + "value": "AddRemoveIncrementalNamedPartition", + "description": "Represents a scaling mechanism for adding or removing named partitions of a stateless service. The value is 1." + } + ] + } + }, + "ServiceScalingTriggerKind": { + "type": "string", + "description": "Enumerates the ways that a service can be partitioned.", + "enum": [ + "AveragePartitionLoadTrigger", + "AverageServiceLoadTrigger" + ], + "x-ms-enum": { + "name": "ServiceScalingTriggerKind", + "modelAsString": true, + "values": [ + { + "value": "AveragePartitionLoadTrigger", + "description": "Represents a scaling trigger related to an average load of a metric/resource of a partition. The value is 0." + }, + { + "value": "AverageServiceLoadTrigger", + "description": "Represents a scaling policy related to an average load of a metric/resource of a service. The value is 1." + } + ] + } + }, + "ServiceTypeHealthPolicy": { + "type": "object", + "description": "Represents the health policy used to evaluate the health of services belonging to a service type.\n", + "required": [ + "maxPercentUnhealthyServices", + "maxPercentUnhealthyPartitionsPerService", + "maxPercentUnhealthyReplicasPerPartition" + ], + "properties": { + "maxPercentUnhealthyServices": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy services.\n\nThe percentage represents the maximum tolerated percentage of services that can be unhealthy before the application is considered in error.\nIf the percentage is respected but there is at least one unhealthy service, the health is evaluated as Warning.\nThis is calculated by dividing the number of unhealthy services of the specific service type over the total number of services of the specific service type.\nThe computation rounds up to tolerate one failure on small numbers of services.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyPartitionsPerService": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy partitions per service.\n\nThe percentage represents the maximum tolerated percentage of partitions that can be unhealthy before the service is considered in error.\nIf the percentage is respected but there is at least one unhealthy partition, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy partitions over the total number of partitions in the service.\nThe computation rounds up to tolerate one failure on small numbers of partitions.\n", + "minimum": 0, + "maximum": 100 + }, + "maxPercentUnhealthyReplicasPerPartition": { + "type": "integer", + "format": "int32", + "description": "The maximum allowed percentage of unhealthy replicas per partition.\n\nThe percentage represents the maximum tolerated percentage of replicas that can be unhealthy before the partition is considered in error.\nIf the percentage is respected but there is at least one unhealthy replica, the health is evaluated as Warning.\nThe percentage is calculated by dividing the number of unhealthy replicas over the total number of replicas in the partition.\nThe computation rounds up to tolerate one failure on small numbers of replicas.\n", + "minimum": 0, + "maximum": 100 + } + } + }, + "ServiceTypeHealthPolicyMap": { + "type": "object", + "description": "Defines a ServiceTypeHealthPolicy per service type name.\n\nThe entries in the map replace the default service type health policy for each specified service type.\nFor example, in an application that contains both a stateless gateway service type and a stateful engine service type, the health policies for the stateless and stateful services can be configured differently.\nWith policy per service type, there's more granular control of the health of the service.\n\nIf no policy is specified for a service type name, the DefaultServiceTypeHealthPolicy is used for evaluation.\n", + "additionalProperties": { + "$ref": "#/definitions/ServiceTypeHealthPolicy" + } + }, + "ServiceUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Service update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Service update request" + }, + "SingletonPartitionScheme": { + "type": "object", + "description": "Describes the partition scheme of a singleton-partitioned, or non-partitioned service.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "SingletonPartitionScheme" + } + ], + "x-ms-discriminator-value": "Singleton" + }, + "StatefulServiceProperties": { + "type": "object", + "description": "The properties of a stateful service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateful", + "properties": { + "hasPersistedState": { + "type": "boolean", + "description": "A flag indicating whether this is a persistent service which stores states on the local disk. If it is then the value of this property is true, if not it is false." + }, + "targetReplicaSetSize": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The target replica set size as a number." + }, + "minReplicaSetSize": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "The minimum replica set size as a number." + }, + "replicaRestartWaitDuration": { + "type": "string", + "description": "The duration between when a replica goes down and when a new replica is created, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "quorumLossWaitDuration": { + "type": "string", + "description": "The maximum duration for which a partition is allowed to be in a state of quorum loss, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "standByReplicaKeepDuration": { + "type": "string", + "description": "The definition on how long StandBy replicas should be maintained before being removed, represented in ISO 8601 format \"hh:mm:ss\"." + }, + "servicePlacementTimeLimit": { + "type": "string", + "description": "The duration for which replicas can stay InBuild before reporting that build is stuck, represented in ISO 8601 format \"hh:mm:ss\"." + } + } + }, + "StatelessServiceProperties": { + "type": "object", + "description": "The properties of a stateless service resource.", + "allOf": [ + { + "$ref": "#/definitions/ServiceResourceProperties" + } + ], + "x-ms-discriminator-value": "Stateless", + "required": [ + "instanceCount" + ], + "properties": { + "instanceCount": { + "type": "integer", + "format": "int32", + "minimum": -1, + "description": "The instance count." + }, + "minInstanceCount": { + "type": "integer", + "format": "int32", + "description": "MinInstanceCount is the minimum number of instances that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstanceCount computation -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service." + }, + "minInstancePercentage": { + "type": "integer", + "format": "int32", + "description": "MinInstancePercentage is the minimum percentage of InstanceCount that must be up to meet the EnsureAvailability safety check during operations like upgrade or deactivate node. The actual number that is used is max( MinInstanceCount, ceil( MinInstancePercentage/100.0 * InstanceCount) ). Note, if InstanceCount is set to -1, during MinInstancePercentage computation, -1 is first converted into the number of nodes on which the instances are allowed to be placed according to the placement constraints on the service." + } + } + }, + "UniformInt64RangePartitionScheme": { + "type": "object", + "description": "Describes a partitioning scheme where an integer range is allocated evenly across a number of partitions.", + "allOf": [ + { + "$ref": "#/definitions/Partition" + }, + { + "type": "object", + "description": "UniformInt64RangePartitionScheme" + } + ], + "x-ms-discriminator-value": "UniformInt64Range", + "required": [ + "count", + "lowKey", + "highKey" + ], + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "The number of partitions." + }, + "lowKey": { + "type": "integer", + "format": "int64", + "description": "The lower bound of the partition key range that\nshould be split between the partition ‘Count’\n" + }, + "highKey": { + "type": "integer", + "format": "int64", + "description": "The upper bound of the partition key range that\nshould be split between the partition ‘Count’\n" + } + } + }, + "UpgradeDomainTimeout": { + "type": "string", + "description": "The amount of time each upgrade domain has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "UpgradeTimeout": { + "type": "string", + "description": "The amount of time the overall upgrade has to complete before FailureAction is executed. Cannot be larger than 12 hours. It is interpreted as a string representing an ISO 8601 duration with following format \"hh:mm:ss.fff\"." + }, + "UserAssignedIdentity": { + "type": "object", + "properties": { + "principalId": { + "type": "string", + "readOnly": true, + "description": "The principal id of user assigned identity." + }, + "clientId": { + "type": "string", + "readOnly": true, + "description": "The client id of user assigned identity." + } + } + }, + "UserAssignedIdentityMap": { + "type": "object", + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form:\n'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.\n", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2023-03-01-preview\" for this specification.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "applicationName": { + "name": "applicationName", + "in": "path", + "description": "The name of the application resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "applicationTypeName": { + "name": "applicationTypeName", + "in": "path", + "description": "The name of the application type name resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "serviceName": { + "name": "serviceName", + "in": "path", + "description": "The name of the service resource in the format of {applicationName}~{serviceName}.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "version": { + "name": "version", + "in": "path", + "description": "The application type version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/managedcluster.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/managedcluster.json new file mode 100644 index 000000000000..5a1f202d1e03 --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/managedcluster.json @@ -0,0 +1,2027 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2023-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters": { + "get": { + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Gets the list of Service Fabric cluster resources created in the specified resource group.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "ManagedCluster" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List cluster by resource group": { + "$ref": "./examples/ManagedClusterListByResourceGroupOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/managedClusters": { + "get": { + "operationId": "ManagedClusters_ListBySubscription", + "summary": "Gets the list of Service Fabric cluster resources created in the specified subscription.", + "description": "Gets all Service Fabric cluster resources created or in the process of being created in the subscription.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "tags": [ + "ManagedCluster" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List managed clusters": { + "$ref": "./examples/ManagedClusterListBySubscriptionOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}": { + "get": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a Service Fabric managed cluster resource.", + "description": "Get a Service Fabric managed cluster resource created or in the process of being created in the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Get a cluster": { + "$ref": "./examples/ManagedClusterGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric managed cluster resource.", + "description": "Create or update a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The cluster resource.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a cluster with minimum parameters": { + "$ref": "./examples/ManagedClusterPutOperation_example_min.json" + }, + "Put a cluster with maximum parameters": { + "$ref": "./examples/ManagedClusterPutOperation_example_max.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Update", + "summary": "Updates the tags of of a Service Fabric managed cluster resource.", + "description": "Update the tags of of a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "parameters", + "in": "body", + "description": "The managed cluster resource updated tags.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a managed cluster": { + "$ref": "./examples/ManagedClusterPatchOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "ManagedCluster" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a Service Fabric managed cluster resource.", + "description": "Delete a Service Fabric managed cluster resource with the specified name.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Delete a cluster": { + "$ref": "./examples/ManagedClusterDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/getazresiliencystatus": { + "post": { + "tags": [ + "managedAzResiliencyStatus" + ], + "summary": "Action to get Az Resiliency Status of all the Base resources constituting Service Fabric Managed Clusters.", + "description": "Action to get Az Resiliency Status of all the Base resources constituting Service Fabric Managed Clusters.", + "operationId": "managedAzResiliencyStatus_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "Az Resiliency status of Base Resources": { + "$ref": "./examples/managedAzResiliencyStatusGet_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedAzResiliencyStatus" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions/{clusterVersion}": { + "get": { + "operationId": "ManagedClusterVersion_Get", + "summary": "Gets information about a Service Fabric managed cluster code version available in the specified location.", + "description": "Gets information about an available Service Fabric managed cluster code version.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version": { + "$ref": "./examples/ManagedClusterVersionGet_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions/{clusterVersion}": { + "get": { + "operationId": "ManagedClusterVersion_GetByEnvironment", + "summary": "Gets information about a Service Fabric cluster code version available for the specified environment.", + "description": "Gets information about an available Service Fabric cluster code version by environment.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterVersion" + } + ], + "x-ms-examples": { + "Get cluster version by environment": { + "$ref": "./examples/ManagedClusterVersionGetByEnvironment_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterVersions": { + "get": { + "operationId": "ManagedClusterVersion_List", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified location.", + "description": "Gets all available code versions for Service Fabric cluster resources by location.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions": { + "$ref": "./examples/ManagedClusterVersionList_example.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/environments/{environment}/managedClusterVersions": { + "get": { + "operationId": "ManagedClusterVersion_ListByEnvironment", + "summary": "Gets the list of Service Fabric cluster code versions available for the specified environment.", + "description": "Gets all available code versions for Service Fabric cluster resources by environment.", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/environment" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List cluster versions by environment": { + "$ref": "./examples/ManagedClusterVersionListByEnvironment.json" + } + }, + "tags": [ + "ManagedClusterVersion" + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedClusterCodeVersionListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedUnsupportedVMSizes": { + "get": { + "tags": [ + "managedVMSizes" + ], + "summary": "Get the lists of unsupported vm sizes for Service Fabric Managed Clusters.", + "description": "Get the lists of unsupported vm sizes for Service Fabric Managed Clusters.", + "operationId": "managedUnsupportedVMSizes_List", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "x-ms-examples": { + "List unsupported vm sizes": { + "$ref": "./examples/managedUnsupportedVMSizesList_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedVMSizesResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedUnsupportedVMSizes/{vmSize}": { + "get": { + "tags": [ + "managedVMSizes" + ], + "summary": "Get unsupported vm size for Service Fabric Managed Clusters.", + "description": "Get unsupported vm size for Service Fabric Managed Clusters.", + "operationId": "managedUnsupportedVMSizes_Get", + "parameters": [ + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/vmSize" + } + ], + "x-ms-examples": { + "Get unsupported vm sizes": { + "$ref": "./examples/managedUnsupportedVMSizesGet_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/ManagedVMSize" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterOperations/{operationId}": { + "get": { + "tags": [ + "LongRunningOperations" + ], + "summary": "Get long running operation status.", + "description": "Get long running operation status.", + "operationId": "OperationStatus_Get", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/operationId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get failed operation status": { + "$ref": "./examples/Long_running_operation_status_failed.json" + }, + "Get succeeded operation result": { + "$ref": "./examples/Long_running_operation_status_succeeded.json" + } + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LongRunningOperationResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ServiceFabric/locations/{location}/managedClusterOperationResults/{operationId}": { + "get": { + "tags": [ + "LongRunningOperations" + ], + "summary": "Get long running operation result.", + "description": "Get long running operation result.", + "operationId": "OperationResults_Get", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/locationForClusterCodeVersions" + }, + { + "$ref": "#/parameters/operationId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get operation result": { + "$ref": "./examples/Long_running_operation_result.json" + } + }, + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request is still running." + }, + "204": { + "description": "No Content. For Delete operation results." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/providers/Microsoft.ServiceFabric/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "Lists all of the available Service Fabric resource provider API operations.", + "description": "Get the list of available Service Fabric resource provider API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API", + "required": true, + "type": "string" + } + ], + "x-ms-examples": { + "List available operations": { + "$ref": "./examples/Operations_example.json" + } + }, + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ManagedClusterAddOnFeature": { + "type": "string", + "description": "Available cluster add-on features", + "enum": [ + "DnsService", + "BackupRestoreService", + "ResourceMonitorService" + ], + "x-ms-enum": { + "name": "ManagedClusterAddOnFeature", + "modelAsString": true, + "values": [ + { + "value": "DnsService", + "description": "Dns service" + }, + { + "value": "BackupRestoreService", + "description": "Backup and restore service" + }, + { + "value": "ResourceMonitorService", + "description": "Resource monitor service" + } + ] + } + }, + "ApplicationTypeVersionsCleanupPolicy": { + "type": "object", + "required": [ + "maxUnusedVersionsToKeep" + ], + "properties": { + "maxUnusedVersionsToKeep": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "Number of unused versions per application type to keep." + } + }, + "description": "The policy used to clean up unused versions. When the policy is not specified explicitly, the default unused application versions to keep will be 3." + }, + "AzureActiveDirectory": { + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "Azure active directory tenant id." + }, + "clusterApplication": { + "type": "string", + "description": "Azure active directory cluster application id." + }, + "clientApplication": { + "type": "string", + "description": "Azure active directory client application id." + } + }, + "description": "The settings to enable AAD authentication on the cluster." + }, + "ClientCertificate": { + "type": "object", + "required": [ + "isAdmin" + ], + "properties": { + "isAdmin": { + "type": "boolean", + "description": "Indicates if the client certificate has admin access to the cluster. Non admin clients can perform only read only operations on the cluster." + }, + "thumbprint": { + "type": "string", + "description": "Certificate thumbprint." + }, + "commonName": { + "type": "string", + "description": "Certificate common name." + }, + "issuerThumbprint": { + "type": "string", + "description": "Issuer thumbprint for the certificate. Only used together with CommonName." + } + }, + "description": "Client certificate definition." + }, + "ClusterState": { + "type": "string", + "description": "The current state of the cluster.\n", + "enum": [ + "WaitingForNodes", + "Deploying", + "BaselineUpgrade", + "Upgrading", + "UpgradeFailed", + "Ready" + ], + "x-ms-enum": { + "name": "ClusterState", + "modelAsString": true, + "values": [ + { + "value": "WaitingForNodes", + "description": "Indicates that the cluster resource is created and the resource provider is waiting for Service Fabric VM extension to boot up and report to it." + }, + { + "value": "Deploying", + "description": "Indicates that the Service Fabric runtime is being installed on the VMs. Cluster resource will be in this state until the cluster boots up and system services are up." + }, + { + "value": "BaselineUpgrade", + "description": "Indicates that the cluster is upgrading to establishes the cluster version. This upgrade is automatically initiated when the cluster boots up for the first time." + }, + { + "value": "Upgrading", + "description": "Indicates that the cluster is being upgraded with the user provided configuration." + }, + { + "value": "UpgradeFailed", + "description": "Indicates that the last upgrade for the cluster has failed." + }, + { + "value": "Ready", + "description": "Indicates that the cluster is in a stable state." + } + ] + } + }, + "ClusterUpgradeCadence": { + "type": "string", + "enum": [ + "Wave0", + "Wave1", + "Wave2" + ], + "x-ms-enum": { + "name": "clusterUpgradeCadence", + "modelAsString": true, + "values": [ + { + "value": "Wave0", + "description": "Cluster upgrade starts immediately after a new version is rolled out. Recommended for Test/Dev clusters." + }, + { + "value": "Wave1", + "description": "Cluster upgrade starts 7 days after a new version is rolled out. Recommended for Pre-prod clusters." + }, + { + "value": "Wave2", + "description": "Cluster upgrade starts 14 days after a new version is rolled out. Recommended for Production clusters." + } + ] + }, + "description": "Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0." + }, + "ClusterUpgradeMode": { + "type": "string", + "description": "The upgrade mode of the cluster when new Service Fabric runtime version is available.\n", + "enum": [ + "Automatic", + "Manual" + ], + "default": "Automatic", + "x-ms-enum": { + "name": "ClusterUpgradeMode", + "modelAsString": true, + "values": [ + { + "value": "Automatic", + "description": "The cluster will be automatically upgraded to the latest Service Fabric runtime version, **clusterUpgradeCadence** will determine when the upgrade starts after the new version becomes available." + }, + { + "value": "Manual", + "description": "The cluster will not be automatically upgraded to the latest Service Fabric runtime version. The cluster is upgraded by setting the **clusterCodeVersion** property in the cluster resource." + } + ] + } + }, + "IPTag": { + "type": "object", + "required": [ + "ipTagType", + "tag" + ], + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag." + } + }, + "description": "IPTag associated with the object." + }, + "LoadBalancingRule": { + "type": "object", + "required": [ + "frontendPort", + "backendPort", + "protocol", + "probeProtocol" + ], + "properties": { + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 1 and 65534.", + "minimum": 1, + "maximum": 65534 + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535.", + "minimum": 1, + "maximum": 65534 + }, + "protocol": { + "type": "string", + "description": "The reference to the transport protocol used by the load balancing rule.", + "enum": [ + "tcp", + "udp" + ], + "x-ms-enum": { + "name": "protocol", + "modelAsString": true + } + }, + "probePort": { + "type": "integer", + "format": "int32", + "description": "The prob port used by the load balancing rule. Acceptable values are between 1 and 65535.", + "minimum": 1, + "maximum": 65534 + }, + "probeProtocol": { + "type": "string", + "description": "the reference to the load balancer probe used by the load balancing rule.", + "enum": [ + "tcp", + "http", + "https" + ], + "x-ms-enum": { + "name": "probeProtocol", + "modelAsString": true + } + }, + "probeRequestPath": { + "type": "string", + "description": "The probe request path. Only supported for HTTP/HTTPS probes." + }, + "loadDistribution": { + "type": "string", + "description": "The load distribution policy for this rule." + } + }, + "description": "Describes a load balancing rule." + }, + "LongRunningOperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "startTime": { + "type": "string", + "description": "The start time of the operation.", + "format": "date-time" + }, + "endTime": { + "type": "string", + "description": "The end time of the operation.", + "format": "date-time" + }, + "percentComplete": { + "type": "number", + "format": "double", + "description": "The completion percentage of the operation." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The operation error." + } + }, + "description": "Long running operation result." + }, + "ManagedCluster": { + "type": "object", + "required": [ + "sku" + ], + "description": "The managed cluster resource\n", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedClusterProperties", + "description": "The managed cluster resource properties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the managed cluster" + } + } + }, + "ManagedClusterCodeVersionListResult": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterCodeVersionResult" + }, + "description": "The list results of the Service Fabric runtime versions." + }, + "ManagedClusterCodeVersionResult": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The identification of the result" + }, + "name": { + "type": "string", + "description": "The name of the result" + }, + "type": { + "type": "string", + "description": "The result resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedClusterVersionDetails" + } + }, + "description": "The result of the Service Fabric runtime versions" + }, + "ManagedClusterListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Managed Cluster list results" + }, + "ManagedClusterProperties": { + "type": "object", + "required": [ + "dnsName", + "adminUserName" + ], + "properties": { + "dnsName": { + "type": "string", + "description": "The cluster dns name." + }, + "fqdn": { + "type": "string", + "description": "The fully qualified domain name associated with the public load balancer of the cluster.", + "readOnly": true + }, + "ipv4Address": { + "type": "string", + "description": "The IPv4 address associated with the public load balancer of the cluster.", + "readOnly": true + }, + "clusterId": { + "type": "string", + "description": "A service generated unique identifier for the cluster resource.", + "readOnly": true + }, + "clusterState": { + "readOnly": true, + "$ref": "#/definitions/ClusterState", + "description": "The current state of the cluster." + }, + "clusterCertificateThumbprints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of thumbprints of the cluster certificates.", + "readOnly": true + }, + "clientConnectionPort": { + "type": "integer", + "format": "int32", + "description": "The port used for client connections to the cluster.", + "default": 19000 + }, + "httpGatewayConnectionPort": { + "type": "integer", + "format": "int32", + "description": "The port used for HTTP connections to the cluster.", + "default": 19080 + }, + "adminUserName": { + "type": "string", + "description": "VM admin user name." + }, + "adminPassword": { + "type": "string", + "x-ms-secret": true, + "format": "password", + "description": "VM admin user password." + }, + "loadBalancingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancingRule" + }, + "x-ms-identifiers": [], + "description": "Load balancing rules that are applied to the public load balancer of the cluster." + }, + "allowRdpAccess": { + "type": "boolean", + "description": "Setting this to true enables RDP access to the VM. The default NSG rule opens RDP port to Internet which can be overridden with custom Network Security Rules. The default value for this setting is false." + }, + "networkSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityRule" + }, + "x-ms-identifiers": [], + "description": "Custom Network Security Rules that are applied to the Virtual Network of the cluster." + }, + "clients": { + "type": "array", + "items": { + "$ref": "#/definitions/ClientCertificate" + }, + "x-ms-identifiers": [], + "description": "Client certificates that are allowed to manage the cluster." + }, + "azureActiveDirectory": { + "$ref": "#/definitions/AzureActiveDirectory", + "description": "The AAD authentication settings of the cluster." + }, + "fabricSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/SettingsSectionDescription" + }, + "x-ms-identifiers": [], + "description": "The list of custom fabric settings to configure the cluster." + }, + "provisioningState": { + "$ref": "#/definitions/ManagedResourceProvisioningState", + "readOnly": true, + "description": "The provisioning state of the managed cluster resource." + }, + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster. This property is required when **clusterUpgradeMode** is set to 'Manual'. To get list of available Service Fabric versions for new clusters use [ClusterVersion API](./ClusterVersion.md). To get the list of available version for existing clusters use **availableClusterVersions**." + }, + "clusterUpgradeMode": { + "$ref": "#/definitions/ClusterUpgradeMode" + }, + "clusterUpgradeCadence": { + "$ref": "#/definitions/ClusterUpgradeCadence", + "description": "Indicates when new cluster runtime version upgrades will be applied after they are released. By default is Wave0. Only applies when **clusterUpgradeMode** is set to 'Automatic'." + }, + "addonFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAddOnFeature" + }, + "description": "List of add-on features to enable on the cluster." + }, + "enableAutoOSUpgrade": { + "type": "boolean", + "description": "Setting this to true enables automatic OS upgrade for the node types that are created using any platform OS image with version 'latest'. The default value for this setting is false." + }, + "zonalResiliency": { + "type": "boolean", + "description": "Indicates if the cluster has zone resiliency.", + "default": false + }, + "applicationTypeVersionsCleanupPolicy": { + "$ref": "#/definitions/ApplicationTypeVersionsCleanupPolicy", + "description": "The policy used to clean up unused versions." + }, + "enableIpv6": { + "type": "boolean", + "description": "Setting this to true creates IPv6 address space for the default VNet used by the cluster. This setting cannot be changed once the cluster is created. The default value for this setting is false." + }, + "subnetId": { + "type": "string", + "description": "If specified, the node types for the cluster are created in this subnet instead of the default VNet. The **networkSecurityRules** specified for the cluster are also applied to this subnet. This setting cannot be changed once the cluster is created." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IPTag" + }, + "x-ms-identifiers": [], + "description": "The list of IP tags associated with the default public IP address of the cluster." + }, + "ipv6Address": { + "type": "string", + "description": "IPv6 address for the cluster if IPv6 is enabled.", + "readOnly": true + }, + "enableServicePublicIP": { + "type": "boolean", + "description": "Setting this to true will link the IPv4 address as the ServicePublicIP of the IPv6 address. It can only be set to True if IPv6 is enabled on the cluster." + }, + "auxiliarySubnets": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "x-ms-identifiers": [], + "description": "Auxiliary subnets for the cluster." + }, + "serviceEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpoint" + }, + "x-ms-identifiers": [], + "description": "Service endpoints for subnets in the cluster." + }, + "zonalUpdateMode": { + "$ref": "#/definitions/ZonalUpdateMode", + "description": "Indicates the update mode for Cross Az clusters." + }, + "useCustomVnet": { + "type": "boolean", + "description": "For new clusters, this parameter indicates that it uses Bring your own VNet, but the subnet is specified at node type level; and for such clusters, the subnetId property is required for node types." + }, + "publicIPPrefixId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + }, + "description": "Specify the resource id of a public IP prefix that the load balancer will allocate a public IP address from. Only supports IPv4." + } + }, + "description": "Describes the managed cluster resource properties." + }, + "ManagedClusterUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Managed cluster update parameters", + "additionalProperties": { + "type": "string" + } + } + }, + "description": "Managed cluster update request" + }, + "ManagedClusterVersionDetails": { + "type": "object", + "properties": { + "clusterCodeVersion": { + "type": "string", + "description": "The Service Fabric runtime version of the cluster." + }, + "supportExpiryUtc": { + "type": "string", + "description": "The date of expiry of support of the version." + }, + "osType": { + "$ref": "#/definitions/OsType" + } + }, + "description": "The detail of the Service Fabric runtime version result" + }, + "ManagedVMSize": { + "type": "object", + "properties": { + "properties": { + "description": "VM Size properties.", + "$ref": "#/definitions/VMSize", + "readOnly": true + }, + "id": { + "type": "string", + "description": "VM Size id.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "VM Size name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "VM Size type.", + "readOnly": true + } + }, + "description": "Describes a VM Sizes." + }, + "ManagedVMSizesResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of Managed VM Sizes for Service Fabric Managed Clusters.", + "items": { + "$ref": "#/definitions/ManagedVMSize" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of Managed VM Sizes if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Managed VM Sizes for Service Fabric Managed Clusters." + }, + "ManagedAzResiliencyStatus": { + "type": "object", + "properties": { + "baseResourceStatus": { + "type": "array", + "description": "List of Managed VM Sizes for Service Fabric Managed Clusters.", + "items": { + "$ref": "#/definitions/ResourceAzStatus" + }, + "x-ms-identifiers": [] + }, + "isClusterZoneResilient": { + "type": "boolean", + "description": "URL to get the next set of Managed VM Sizes if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Managed VM Sizes for Service Fabric Managed Clusters." + }, + "ResourceAzStatus": { + "type": "object", + "properties": { + "resourceName": { + "type": "string", + "description": "VM Size properties.", + "readOnly": true + }, + "resourceType": { + "type": "string", + "description": "VM Size id.", + "readOnly": true + }, + "isZoneResilient": { + "type": "boolean", + "description": "VM Size name.", + "readOnly": true + } + }, + "description": "Describes Az Resiliency status of Base resources" + }, + "OsType": { + "type": "string", + "description": "Cluster operating system, the default will be Windows", + "enum": [ + "Windows" + ], + "x-ms-enum": { + "name": "OsType", + "modelAsString": true, + "values": [ + { + "value": "Windows", + "description": "Indicates os is Windows." + } + ] + } + }, + "ServiceEndpoint": { + "type": "object", + "required": [ + "service" + ], + "properties": { + "service": { + "type": "string", + "description": "The type of the endpoint service." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + } + }, + "description": "The service endpoint properties." + }, + "Sku": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "Sku Name." + } + }, + "description": "Service Fabric managed cluster Sku definition" + }, + "SkuName": { + "type": "string", + "description": "Sku Name.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true, + "values": [ + { + "value": "Basic", + "description": "Basic requires a minimum of 3 nodes and allows only 1 node type." + }, + { + "value": "Standard", + "description": "Requires a minimum of 5 nodes and allows 1 or more node type." + } + ] + } + }, + "Subnet": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string", + "description": "Subnet name." + }, + "enableIpv6": { + "type": "boolean", + "description": "Indicates wether to enable Ipv6 or not. If not provided, it will take the same configuration as the cluster." + }, + "privateEndpointNetworkPolicies": { + "type": "string", + "description": "Enable or Disable apply network policies on private end point in the subnet.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "privateEndpointNetworkPolicies", + "modelAsString": true + } + }, + "privateLinkServiceNetworkPolicies": { + "type": "string", + "description": "Enable or Disable apply network policies on private link service in the subnet.", + "enum": [ + "enabled", + "disabled" + ], + "x-ms-enum": { + "name": "privateLinkServiceNetworkPolicies", + "modelAsString": true + } + }, + "networkSecurityGroupId": { + "type": "string", + "description": "Full resource id for the network security group." + } + }, + "description": "Describes a Subnet." + }, + "VMSize": { + "type": "object", + "properties": { + "size": { + "type": "string", + "description": "VM Size name.", + "readOnly": true + } + }, + "description": "VM Sizes properties." + }, + "ZonalUpdateMode": { + "type": "string", + "description": "Indicates the update mode for Cross Az clusters.", + "enum": [ + "Standard", + "Fast" + ], + "x-ms-enum": { + "name": "ZonalUpdateMode", + "modelAsString": true, + "values": [ + { + "value": "Standard", + "description": "The cluster will use 5 upgrade domains for Cross Az Node types." + }, + { + "value": "Fast", + "description": "The cluster will use a maximum of 3 upgrade domains per zone instead of 5 for Cross Az Node types for faster deployments." + } + ] + } + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ManagedResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of the managed resource.", + "enum": [ + "None", + "Creating", + "Created", + "Updating", + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "Deleted", + "Other" + ], + "x-ms-enum": { + "name": "ManagedResourceProvisioningState", + "modelAsString": true + } + }, + "NetworkSecurityRule": { + "type": "object", + "required": [ + "name", + "protocol", + "access", + "priority", + "direction" + ], + "properties": { + "name": { + "type": "string", + "description": "Network security rule name." + }, + "description": { + "type": "string", + "description": "Network security rule description." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "http", + "https", + "tcp", + "udp", + "icmp", + "ah", + "esp" + ], + "x-ms-enum": { + "name": "nsgProtocol", + "modelAsString": true + } + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges." + }, + "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." + }, + "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." + }, + "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": "he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "access": { + "type": "string", + "description": "The network traffic is allowed or denied.", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "access", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.", + "minimum": 1000, + "maximum": 3000 + }, + "direction": { + "type": "string", + "description": "Network security rule direction.", + "enum": [ + "inbound", + "outbound" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + } + }, + "description": "Describes a network security rule." + }, + "OperationListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "List of operations supported by the Service Fabric resource provider.", + "items": { + "$ref": "#/definitions/OperationResult" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any.", + "readOnly": true + } + }, + "description": "Describes the result of the request to list Service Fabric resource provider operations." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "Resource": { + "type": "object", + "required": [ + "location" + ], + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "location": { + "type": "string", + "description": "Azure resource location.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "description": "Azure resource tags.", + "additionalProperties": { + "type": "string" + } + }, + "etag": { + "type": "string", + "description": "Azure resource etag.", + "readOnly": true + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition.", + "x-ms-azure-resource": true + }, + "SettingsParameterDescription": { + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "The parameter name of fabric setting." + }, + "value": { + "type": "string", + "description": "The parameter value of fabric setting." + } + }, + "description": "Describes a parameter in fabric settings of the cluster." + }, + "SettingsSectionDescription": { + "type": "object", + "required": [ + "name", + "parameters" + ], + "properties": { + "name": { + "type": "string", + "description": "The section name of the fabric settings." + }, + "parameters": { + "type": "array", + "description": "The collection of parameters in the section.", + "items": { + "$ref": "#/definitions/SettingsParameterDescription" + }, + "x-ms-identifiers": [ + "name" + ] + } + }, + "description": "Describes a section in the fabric settings of the cluster." + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2023-03-01-preview\" for this specification.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "clusterVersion": { + "name": "clusterVersion", + "in": "path", + "description": "The cluster code version.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "environment": { + "name": "environment", + "in": "path", + "description": "The operating system of the cluster. The default means all.", + "required": true, + "type": "string", + "enum": [ + "Windows" + ], + "x-ms-parameter-location": "method", + "x-ms-enum": { + "name": "ManagedClusterVersionEnvironment", + "modelAsString": true, + "values": [ + { + "value": "Windows", + "description": "Windows." + } + ] + } + }, + "locationForClusterCodeVersions": { + "name": "location", + "in": "path", + "description": "The location for the cluster code versions. This is different from cluster location.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "operationId": { + "name": "operationId", + "in": "path", + "description": "operation identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "vmSize": { + "name": "vmSize", + "in": "path", + "description": "VM Size name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/nodetype.json b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/nodetype.json new file mode 100644 index 000000000000..8635c00295ba --- /dev/null +++ b/specification/servicefabricmanagedclusters/resource-manager/Microsoft.ServiceFabric/preview/2023-03-01-preview/nodetype.json @@ -0,0 +1,1729 @@ +{ + "swagger": "2.0", + "info": { + "title": "ServiceFabricManagementClient", + "description": "Azure Service Fabric Resource Provider API Client", + "version": "2023-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes": { + "get": { + "operationId": "NodeTypes_ListByManagedClusters", + "summary": "Gets the list of Node types of the specified managed cluster.", + "description": "Gets all Node types of the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "tags": [ + "NodeType" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List node type of the specified managed cluster": { + "$ref": "./examples/NodeTypeListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeTypeListResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/restart": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Restart", + "summary": "Restarts one or more nodes on the node type.", + "description": "Restarts one or more nodes on the node type. It will disable the fabric nodes, trigger a restart on the VMs and activate the nodes back again.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for restart action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Restart nodes": { + "$ref": "./examples/RestartNodes_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/reimage": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Reimage", + "summary": "Reimages one or more nodes on the node type.", + "description": "Reimages one or more nodes on the node type. It will disable the fabric nodes, trigger a reimage on the VMs and activate the nodes back again.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for reimage action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Reimage nodes": { + "$ref": "./examples/ReimageNodes_example.json" + }, + "Reimage all nodes By upgrade domain": { + "$ref": "./examples/ReimageNodes_UD_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/deleteNode": { + "post": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_DeleteNode", + "summary": "Deletes one or more nodes on the node type.", + "description": "Deletes one or more nodes on the node type. It will disable the fabric nodes, trigger a delete on the VMs and removes the state from the cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "parameters for delete action.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeActionParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Delete nodes": { + "$ref": "./examples/DeleteNodes_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}/skus": { + "get": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypeSkus_List", + "summary": "Gets a Service Fabric node type SKUs.", + "description": "Get a Service Fabric node type supported SKUs.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List a node type SKUs": { + "$ref": "./examples/NodeTypeSkusListOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeTypeListSkuResult" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceFabric/managedClusters/{clusterName}/nodeTypes/{nodeTypeName}": { + "get": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Get", + "summary": "Gets a Service Fabric node type.", + "description": "Get a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Get a node type": { + "$ref": "./examples/NodeTypeGetOperation_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "put": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_CreateOrUpdate", + "summary": "Creates or updates a Service Fabric node type.", + "description": "Create or update a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The node type resource.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeType" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Put a node type with minimum parameters": { + "$ref": "./examples/NodeTypePutOperation_example_min.json" + }, + "Put a node type with maximum parameters": { + "$ref": "./examples/NodeTypePutOperation_example_max.json" + }, + "Put a node type with auto-scale parameters": { + "$ref": "./examples/NodeTypePutOperationAutoScale_example.json" + }, + "Put an stateless node type with temporary disk for service fabric": { + "$ref": "./examples/NodeTypePutOperationStateless_example.json" + }, + "Put node type with dedicated hosts": { + "$ref": "./examples/NodeTypePutOperationDedicatedHost_example.json" + }, + "Put node type with custom vm image": { + "$ref": "./examples/NodeTypePutOperationCustomImage_example.json" + }, + "Put node type with shared galleries custom vm image": { + "$ref": "./examples/NodeTypePutOperationCustomSharedGalleriesImage_example.json" + }, + "Put node type with vm image plan ": { + "$ref": "./examples/NodeTypePutOperationVmImagePlan_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "202": { + "description": "The request was accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "patch": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Update", + "summary": "Update the tags of a node type resource of a given managed cluster.", + "description": "Update the configuration of a node type of a given managed cluster, only updating tags.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters to update the node type configuration.", + "required": true, + "schema": { + "$ref": "#/definitions/NodeTypeUpdateParameters" + }, + "x-ms-parameter-location": "method" + } + ], + "x-ms-examples": { + "Patch a node type": { + "$ref": "./examples/NodeTypePatchOperation_example.json" + }, + "Patch a node type while auto-scaling": { + "$ref": "./examples/NodeTypePatchOperationAutoScale_example.json" + } + }, + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NodeType" + } + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + }, + "delete": { + "tags": [ + "NodeType" + ], + "operationId": "NodeTypes_Delete", + "summary": "Deletes a Service Fabric node type.", + "description": "Delete a Service Fabric node type of a given managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/clusterNameParameter" + }, + { + "$ref": "#/parameters/nodeTypeNameParameter" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "x-ms-examples": { + "Delete a node type": { + "$ref": "./examples/NodeTypeDeleteOperation_example.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "responses": { + "202": { + "description": "The request was accepted and the operation will complete asynchronously." + }, + "204": { + "description": "The resource was not found." + }, + "200": { + "description": "The operation completed successfully." + }, + "default": { + "description": "The detailed error response.", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + } + } + } + } + }, + "definitions": { + "DiskType": { + "type": "string", + "description": "Managed data disk type. IOPS and throughput are given by the disk size, to see more information go to https://docs.microsoft.com/en-us/azure/virtual-machines/disks-types.\n", + "enum": [ + "Standard_LRS", + "StandardSSD_LRS", + "Premium_LRS" + ], + "default": "StandardSSD_LRS", + "x-ms-enum": { + "name": "DiskType", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + } + ] + } + }, + "EvictionPolicyType": { + "type": "string", + "description": "Specifies the eviction policy for virtual machines in a SPOT node type.", + "enum": [ + "Delete", + "Deallocate" + ], + "default": "Delete", + "x-ms-enum": { + "name": "EvictionPolicyType", + "modelAsString": true, + "values": [ + { + "value": "Delete", + "description": "Eviction policy will be Delete for SPOT vms." + }, + { + "value": "Deallocate", + "description": "Eviction policy will be Deallocate for SPOT vms." + } + ] + } + }, + "FrontendConfiguration": { + "type": "object", + "properties": { + "ipAddressType": { + "$ref": "#/definitions/IPAddressType", + "description": "The IP address type of this frontend configuration. If omitted the default value is IPv4." + }, + "loadBalancerBackendAddressPoolId": { + "type": "string", + "description": "The resource Id of the Load Balancer backend address pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//backendAddressPools/'." + }, + "loadBalancerInboundNatPoolId": { + "type": "string", + "description": "The resource Id of the Load Balancer inbound NAT pool that the VM instances of the node type are associated with. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/loadBalancers//inboundNatPools/'." + }, + "applicationGatewayBackendAddressPoolId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/applicationGateways/backendAddressPools" + } + ] + }, + "description": "The resource Id of application gateway backend address pool. The format of the resource Id is '/subscriptions//resourceGroups//providers/Microsoft.Network/applicationGateways//backendAddressPools/'." + } + }, + "description": "Describes the frontend configurations for the node type." + }, + "IPAddressType": { + "type": "string", + "description": "The IP address type.\n", + "enum": [ + "IPv4", + "IPv6" + ], + "default": "IPv4", + "x-ms-enum": { + "name": "IPAddressType", + "modelAsString": true, + "values": [ + { + "value": "IPv4", + "description": "IPv4 address type." + }, + { + "value": "IPv6", + "description": "IPv6 address type." + } + ] + } + }, + "ManagedProxyResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Azure resource name.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Azure resource type.", + "readOnly": true + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Azure resource tags.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "systemData": { + "$ref": "#/definitions/SystemData" + } + }, + "description": "The resource model definition for proxy-only resource.", + "x-ms-azure-resource": true + }, + "NodeType": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagedProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NodeTypeProperties", + "description": "The node type properties" + }, + "sku": { + "$ref": "#/definitions/NodeTypeSku", + "description": "The node type sku." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "NodeTypeActionParameters": { + "type": "object", + "properties": { + "nodes": { + "description": "List of node names from the node type.", + "type": "array", + "items": { + "type": "string" + } + }, + "force": { + "description": "Force the action to go through.", + "type": "boolean" + }, + "updateType": { + "type": "string", + "description": "Specifies the way the operation will be performed.", + "enum": [ + "Default", + "ByUpgradeDomain" + ], + "x-ms-enum": { + "name": "updateType", + "modelAsString": true, + "values": [ + { + "value": "Default", + "description": "The operation will proceed in all specified nodes at the same time." + }, + { + "value": "ByUpgradeDomain", + "description": "The operation will proceed one upgrade domain at a time, checking the health in between each to continue." + } + ] + } + } + }, + "description": "Parameters for Node type action. If nodes are not specified on the parameters, the operation will be performed in all nodes of the node type one upgrade domain at a time." + }, + "NodeTypeProperties": { + "type": "object", + "required": [ + "isPrimary", + "vmInstanceCount" + ], + "properties": { + "isPrimary": { + "type": "boolean", + "description": "Indicates the Service Fabric system services for the cluster will run on this node type. This setting cannot be changed once the node type is created." + }, + "vmInstanceCount": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the node type.

**Values:**
-1 - Use when auto scale rules are configured or sku.capacity is defined
0 - Not supported
>0 - Use for manual scale.", + "minimum": -1, + "maximum": 2147483647 + }, + "dataDiskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Disk size for the managed disk attached to the vms on the node type in GBs." + }, + "dataDiskType": { + "$ref": "#/definitions/DiskType", + "description": "Managed data disk type. Specifies the storage account type for the managed disk" + }, + "dataDiskLetter": { + "type": "string", + "pattern": "^[a-zA-Z]{1}$", + "description": "Managed data disk letter. It can not use the reserved letter C or D and it can not change after created." + }, + "placementProperties": { + "type": "object", + "description": "The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.", + "additionalProperties": { + "type": "string", + "description": "Placement tag value" + } + }, + "capacities": { + "type": "object", + "description": "The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.", + "additionalProperties": { + "type": "string", + "description": "Capacity tag value" + } + }, + "applicationPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of ports from which cluster assigned port to Service Fabric applications." + }, + "ephemeralPorts": { + "$ref": "#/definitions/EndpointRangeDescription", + "description": "The range of ephemeral ports that nodes in this node type should be configured with." + }, + "vmSize": { + "type": "string", + "description": "The size of virtual machines in the pool. All virtual machines in a pool are the same size. For example, Standard_D3." + }, + "vmImagePublisher": { + "type": "string", + "description": "The publisher of the Azure Virtual Machines Marketplace image. For example, Canonical or MicrosoftWindowsServer." + }, + "vmImageOffer": { + "type": "string", + "description": "The offer type of the Azure Virtual Machines Marketplace image. For example, UbuntuServer or WindowsServer." + }, + "vmImageSku": { + "type": "string", + "description": "The SKU of the Azure Virtual Machines Marketplace image. For example, 14.04.0-LTS or 2012-R2-Datacenter." + }, + "vmImageVersion": { + "type": "string", + "description": "The version of the Azure Virtual Machines Marketplace image. A value of 'latest' can be specified to select the latest version of an image. If omitted, the default is 'latest'." + }, + "vmSecrets": { + "type": "array", + "title": "virtual machine secretes.", + "description": "The secrets to install in the virtual machines.", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "x-ms-identifiers": [ + "sourceVault" + ] + }, + "vmExtensions": { + "type": "array", + "title": "virtual machine extensions.", + "description": "Set of extensions that should be installed onto the virtual machines.", + "items": { + "$ref": "#/definitions/VMSSExtension" + }, + "x-ms-identifiers": [ + "name" + ] + }, + "vmManagedIdentity": { + "$ref": "#/definitions/VmManagedIdentity", + "description": "Identities to assign to the virtual machine scale set under the node type." + }, + "isStateless": { + "type": "boolean", + "description": "Indicates if the node type can only host Stateless workloads.", + "default": false + }, + "multiplePlacementGroups": { + "type": "boolean", + "description": "Indicates if scale set associated with the node type can be composed of multiple placement groups.", + "default": false + }, + "frontendConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendConfiguration" + }, + "x-ms-identifiers": [], + "description": "Indicates the node type uses its own frontend configurations instead of the default one for the cluster. This setting can only be specified for non-primary node types and can not be added or removed after the node type is created." + }, + "networkSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityRule" + }, + "x-ms-identifiers": [], + "description": "The Network Security Rules for this node type. This setting can only be specified for node types that are configured with frontend configurations." + }, + "additionalDataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VmssDataDisk" + }, + "x-ms-identifiers": [ + "lun" + ], + "description": "Additional managed data disks." + }, + "enableEncryptionAtHost": { + "type": "boolean", + "description": "Enable or disable the Host Encryption for the virtual machines on the node type. This will enable the encryption for all the disks including Resource/Temp disk at host itself. Default: The Encryption at host will be disabled unless this property is set to true for the resource.", + "default": false + }, + "provisioningState": { + "$ref": "#/definitions/ManagedResourceProvisioningState", + "readOnly": true, + "description": "The provisioning state of the node type resource." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "useDefaultPublicLoadBalancer": { + "type": "boolean", + "description": "Specifies whether the use public load balancer. If not specified and the node type doesn't have its own frontend configuration, it will be attached to the default load balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is true, then the frontend has to be an Internal Load Balancer. If the node type uses its own Load balancer and useDefaultPublicLoadBalancer is false or not set, then the custom load balancer must include a public load balancer to provide outbound connectivity." + }, + "useTempDataDisk": { + "type": "boolean", + "description": "Specifies whether to use the temporary disk for the service fabric data root, in which case no managed data disk will be attached and the temporary disk will be used. It is only allowed for stateless node types." + }, + "enableOverProvisioning": { + "type": "boolean", + "description": "Specifies whether the node type should be overprovisioned. It is only allowed for stateless node types." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the availability zones where the node type would span across. If the cluster is not spanning across availability zones, initiates az migration for the cluster." + }, + "isSpotVM": { + "type": "boolean", + "description": "Indicates whether the node type will be Spot Virtual Machines. Azure will allocate the VMs if there is capacity available and the VMs can be evicted at any time." + }, + "hostGroupId": { + "type": "string", + "description": "Specifies the full host group resource Id. This property is used for deploying on azure dedicated hosts." + }, + "useEphemeralOSDisk": { + "type": "boolean", + "description": "Indicates whether to use ephemeral os disk. The sku selected on the vmSize property needs to support this feature." + }, + "spotRestoreTimeout": { + "type": "string", + "description": "Indicates the time duration after which the platform will not try to restore the VMSS SPOT instances specified as ISO 8601." + }, + "evictionPolicy": { + "$ref": "#/definitions/EvictionPolicyType", + "description": "Specifies the eviction policy for virtual machines in a SPOT node type. Default is Delete." + }, + "vmImageResourceId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/images" + }, + { + "type": "Microsoft.Compute/galleries/images" + }, + { + "type": "Microsoft.Compute/galleries/images/versions" + } + ] + }, + "description": "Indicates the resource id of the vm image. This parameter is used for custom vm image." + }, + "subnetId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/virtualNetworks/subnets" + } + ] + }, + "description": "Indicates the resource id of the subnet for the node type." + }, + "vmSetupActions": { + "type": "array", + "items": { + "$ref": "#/definitions/VmSetupAction" + }, + "description": "Specifies the actions to be performed on the vms before bootstrapping the service fabric runtime." + }, + "securityType": { + "type": "string", + "description": "Specifies the security type of the nodeType. Only TrustedLaunch is currently supported", + "enum": [ + "TrustedLaunch" + ], + "x-ms-enum": { + "name": "securityType", + "modelAsString": true, + "values": [ + { + "value": "TrustedLaunch", + "description": "Trusted Launch is a security type that secures generation 2 virtual machines." + } + ] + } + }, + "secureBootEnabled": { + "type": "boolean", + "description": "Specifies whether secure boot should be enabled on the nodeType. Can only be used with TrustedLaunch SecurityType" + }, + "enableNodePublicIP": { + "type": "boolean", + "description": "Specifies whether each node is allocated its own public IP address. This is only supported on secondary node types with custom Load Balancers." + }, + "vmSharedGalleryImageId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Compute/sharedGalleries/images" + }, + { + "type": "Microsoft.Compute/sharedGalleries/images/versions" + } + ] + }, + "description": "Indicates the resource id of the vm shared galleries image. This parameter is used for custom vm image." + }, + "natGatewayId": { + "type": "string", + "format": "arm-id", + "x-ms-arm-id-details": { + "allowedResources": [ + { + "type": "Microsoft.Network/natGateways" + } + ] + }, + "description": "Specifies the resource id of a NAT Gateway to attach to the subnet of this node type. Node type must use custom load balancer." + }, + "vmImagePlan": { + "$ref": "#/definitions/VmImagePlan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save." + } + }, + "description": "Describes a node type in the cluster, each node type represents sub set of nodes in the cluster." + }, + "NodeTypeListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "title": "node type list value.", + "description": "The list of node types.", + "items": { + "$ref": "#/definitions/NodeType" + } + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Node type list results" + }, + "NodeTypeUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "description": "Node type update parameters", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/NodeTypeSku", + "description": "The node type sku." + } + }, + "description": "Node type update request" + }, + "NodeTypeSku": { + "type": "object", + "required": [ + "capacity" + ], + "properties": { + "name": { + "type": "string", + "description": "The sku name.

Name is internally generated and is used in auto-scale scenarios.
Property does not allow to be changed to other values than generated.
To avoid deployment errors please omit the property." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of the node type.

Possible Values:
**Standard**" + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The number of nodes in the node type.

If present in request it will override properties.vmInstanceCount.", + "minimum": 1, + "maximum": 2147483647 + } + }, + "description": "Describes a node type sku." + }, + "NodeTypeSkuCapacity": { + "type": "object", + "properties": { + "minimum": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Lowest permitted node count in a node type." + }, + "maximum": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Highest permitted node count in a node type." + }, + "default": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Default node count in a node type." + }, + "scaleType": { + "$ref": "#/definitions/NodeTypeSkuScaleType", + "readOnly": true, + "description": "Node type capacity scale type." + } + }, + "description": "Provides information about how node type can be scaled." + }, + "NodeTypeSkuScaleType": { + "type": "string", + "description": "Node type capacity scale type.\n", + "enum": [ + "None", + "Manual", + "Automatic" + ], + "default": "None", + "x-ms-enum": { + "name": "NodeTypeSkuScaleType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Node count is not adjustable in any way (e.g. it is fixed)." + }, + { + "value": "Manual", + "description": "The user must manually scale out/in." + }, + { + "value": "Automatic", + "description": "Automatic scale is allowed." + } + ] + } + }, + "NodeTypeAvailableSku": { + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The type of resource the sku applies to.

Value: Microsoft.ServiceFabric/managedClusters/nodeTypes." + }, + "sku": { + "$ref": "#/definitions/NodeTypeSupportedSku", + "description": "The supported SKU for a for node type.", + "readOnly": true + }, + "capacity": { + "$ref": "#/definitions/NodeTypeSkuCapacity", + "description": "Provides information about how the node count can be scaled.", + "readOnly": true + } + }, + "description": "Defines the type of sku available for a node type" + }, + "NodeTypeSupportedSku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The sku name.", + "readOnly": true + }, + "tier": { + "type": "string", + "description": "Specifies the tier of the node type.

Possible Values:
**Standard**", + "readOnly": true + } + }, + "description": "Describes a node type supported sku." + }, + "NodeTypeListSkuResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "title": "Node type sku list value.", + "description": "The list of available node type SKUs.", + "items": { + "$ref": "#/definitions/NodeTypeAvailableSku" + }, + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Node type available sku list results" + }, + "SubResource": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Azure resource identifier." + } + }, + "description": "Azure resource identifier.", + "x-ms-azure-resource": true + }, + "VaultCertificate": { + "type": "object", + "required": [ + "certificateUrl", + "certificateStore" + ], + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

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

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name .crt for the X509 certificate file and .prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "type": "object", + "required": [ + "sourceVault", + "vaultCertificates" + ], + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "x-ms-identifiers": [], + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Specifies set of certificates that should be installed onto the virtual machines." + }, + "VmImagePlan": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click Want to deploy programmatically, Get Started ->. Enter any required information and then click Save." + }, + "VmManagedIdentity": { + "type": "object", + "properties": { + "userAssignedIdentities": { + "type": "array", + "description": "The list of user identities associated with the virtual machine scale set under the node type. Each entry will be an ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "items": { + "type": "string" + } + } + }, + "description": "Identities for the virtual machine scale set under the node type." + }, + "VmssDataDisk": { + "type": "object", + "required": [ + "lun", + "diskSizeGB", + "diskType", + "diskLetter" + ], + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "minimum": 1, + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM. Lun 0 is reserved for the service fabric data disk." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Disk size for each vm in the node type in GBs." + }, + "diskType": { + "$ref": "#/definitions/DiskType", + "description": "Managed data disk type. Specifies the storage account type for the managed disk" + }, + "diskLetter": { + "type": "string", + "pattern": "^[a-zA-Z]{1}$", + "description": "Managed data disk letter. It can not use the reserved letter C or D and it can not change after created." + } + }, + "description": "Managed data disk description." + }, + "VmSetupAction": { + "type": "string", + "description": "action to be performed on the vms before bootstrapping the service fabric runtime.", + "enum": [ + "EnableContainers", + "EnableHyperV" + ], + "x-ms-enum": { + "name": "VmSetupAction", + "modelAsString": true, + "values": [ + { + "value": "EnableContainers", + "description": "Enable windows containers feature." + }, + { + "value": "EnableHyperV", + "description": "Enables windows HyperV feature." + } + ] + } + }, + "VMSSExtension": { + "type": "object", + "required": [ + "name", + "properties" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VMSSExtensionProperties", + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + } + }, + "description": "Specifies set of extensions that should be installed onto the virtual machines." + }, + "VMSSExtensionProperties": { + "type": "object", + "required": [ + "publisher", + "type", + "typeHandlerVersion" + ], + "properties": { + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "enableAutomaticUpgrade": { + "type": "boolean", + "description": "Indicates whether the extension should be automatically upgraded by the platform if there is a newer version of the extension available." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "AvailableOperationDisplay": { + "type": "object", + "properties": { + "provider": { + "type": "string", + "description": "The name of the provider." + }, + "resource": { + "type": "string", + "description": "The resource on which the operation is performed" + }, + "operation": { + "type": "string", + "description": "The operation that can be performed." + }, + "description": { + "type": "string", + "description": "Operation description" + } + }, + "description": "Operation supported by the Service Fabric resource provider" + }, + "EndpointRangeDescription": { + "type": "object", + "required": [ + "endPort", + "startPort" + ], + "properties": { + "startPort": { + "type": "integer", + "format": "int32", + "description": "Starting port of a range of ports" + }, + "endPort": { + "type": "integer", + "format": "int32", + "description": "End port of a range of ports" + } + }, + "description": "Port range details" + }, + "ErrorModel": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorModelError", + "description": "The error details." + } + }, + "description": "The structure of the error." + }, + "ErrorModelError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "The error details." + }, + "ManagedResourceProvisioningState": { + "type": "string", + "description": "The provisioning state of the managed resource.", + "enum": [ + "None", + "Creating", + "Created", + "Updating", + "Succeeded", + "Failed", + "Canceled", + "Deleting", + "Deleted", + "Other" + ], + "x-ms-enum": { + "name": "ManagedResourceProvisioningState", + "modelAsString": true + } + }, + "NetworkSecurityRule": { + "type": "object", + "required": [ + "name", + "protocol", + "access", + "priority", + "direction" + ], + "properties": { + "name": { + "type": "string", + "description": "Network security rule name." + }, + "description": { + "type": "string", + "description": "Network security rule description." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "http", + "https", + "tcp", + "udp", + "icmp", + "ah", + "esp" + ], + "x-ms-enum": { + "name": "nsgProtocol", + "modelAsString": true + } + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges." + }, + "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." + }, + "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." + }, + "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": "he destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "access": { + "type": "string", + "description": "The network traffic is allowed or denied.", + "enum": [ + "allow", + "deny" + ], + "x-ms-enum": { + "name": "access", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be in the range 1000 to 3000. Values outside this range are reserved for Service Fabric ManagerCluster Resource Provider. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.", + "minimum": 1000, + "maximum": 3000 + }, + "direction": { + "type": "string", + "description": "Network security rule direction.", + "enum": [ + "inbound", + "outbound" + ], + "x-ms-enum": { + "name": "direction", + "modelAsString": true + } + } + }, + "description": "Describes a network security rule." + }, + "OperationResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "isDataAction": { + "type": "boolean", + "description": "Indicates whether the operation is a data action" + }, + "display": { + "$ref": "#/definitions/AvailableOperationDisplay", + "description": "The object that represents the operation." + }, + "origin": { + "type": "string", + "description": "Origin result" + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Available operation list result" + }, + "SystemData": { + "description": "Metadata pertaining to creation and last modification of the resource.", + "type": "object", + "readOnly": true, + "properties": { + "createdBy": { + "type": "string", + "description": "The identity that created the resource." + }, + "createdByType": { + "type": "string", + "description": "The type of identity that created the resource." + }, + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedBy": { + "type": "string", + "description": "The identity that last modified the resource." + }, + "lastModifiedByType": { + "type": "string", + "description": "The type of identity that last modified the resource." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + } + } + }, + "parameters": { + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the Service Fabric resource provider API. This is a required parameter and it's value must be \"2023-03-01-preview\" for this specification.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "clusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the cluster resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "nodeTypeNameParameter": { + "name": "nodeTypeName", + "in": "path", + "description": "The name of the node type.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The customer subscription identifier.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/servicefabricmanagedclusters/resource-manager/readme.md b/specification/servicefabricmanagedclusters/resource-manager/readme.md index 947ac6fe74a3..ee53c4d00996 100644 --- a/specification/servicefabricmanagedclusters/resource-manager/readme.md +++ b/specification/servicefabricmanagedclusters/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the ServiceFabricManagedClustersManagementClie title: ServiceFabricManagedClustersManagementClient description: Service Fabric Managed Clusters Management Client openapi-type: arm -tag: package-2023-02-preview +tag: package-2023-03-preview directive: - suppress: ListInOperationName @@ -69,6 +69,17 @@ directive: ``` +### Tag: package-2023-03-preview + +These settings apply only when `--tag=package-2023-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2023-03-preview' +input-file: +- Microsoft.ServiceFabric/preview/2023-03-01-preview/managedapplication.json +- Microsoft.ServiceFabric/preview/2023-03-01-preview/managedcluster.json +- Microsoft.ServiceFabric/preview/2023-03-01-preview/nodetype.json +``` + ### Tag: package-2023-02-preview These settings apply only when `--tag=package-2023-02-preview` is specified on the command line. From 3ce676c2fc2338288452c140f2f9d65e61018e8f Mon Sep 17 00:00:00 2001 From: Kalpesh Chavan <18593210+KalpeshChavan12@users.noreply.github.com> Date: Mon, 8 May 2023 12:54:27 +0530 Subject: [PATCH 41/79] [Hub Generated] Publish private branch 'dev-maintenance-Microsoft.Maintenance-2023-04-01' (#23832) * Adds base for updating Microsoft.Maintenance from version preview/2022-07-01-preview to version 2023-04-01 * Updates readme * Updates API version in new specs and examples * Updated schema to support confiuration assignment to resource group and subscription. Removed pre/post task schema. * Added 201 response code for Maintenance Configuration, Configuration Assignment and apply update put call. * Added osTypes Filter in configuration assignment. * Updated description for osType property. * Added 202 status for delete operation. Corrected path for resource group get operation. * Fixed linter issue. * Added x-ms-long-running-operation and removed supression * Added x-ms-long-running-operation for delete api. * Added locations. * Suppressed LroErrorContent * Added suporession for 202 status --------- Co-authored-by: Kalpesh Chavan --- .../stable/2023-04-01/Maintenance.json | 3040 +++++++++++++++++ .../ApplyUpdatesResourceGroup_List.json | 25 + .../examples/ApplyUpdates_CreateOrUpdate.json | 34 + .../ApplyUpdates_CreateOrUpdateParent.json | 36 + .../2023-04-01/examples/ApplyUpdates_Get.json | 24 + .../examples/ApplyUpdates_GetParent.json | 26 + .../examples/ApplyUpdates_List.json | 24 + ...nmentsForResourceGroup_CreateOrUpdate.json | 116 + ...ionAssignmentsForResourceGroup_Delete.json | 19 + ...rationAssignmentsForResourceGroup_Get.json | 46 + ...ntsForResourceGroup_UpdateForResource.json | 76 + ...nmentsForSubscriptions_CreateOrUpdate.json | 123 + ...ionAssignmentsForSubscriptions_Delete.json | 18 + ...rationAssignmentsForSubscriptions_Get.json | 45 + ...ntsForSubscriptions_UpdateForResource.json | 83 + ...ignmentsResultWithinSubscription_List.json | 24 + ...nfigurationAssignments_CreateOrUpdate.json | 40 + ...ationAssignments_CreateOrUpdateParent.json | 42 + .../ConfigurationAssignments_Delete.json | 21 + ...ConfigurationAssignments_DeleteParent.json | 23 + .../ConfigurationAssignments_Get.json | 24 + .../ConfigurationAssignments_GetParent.json | 26 + .../ConfigurationAssignments_List.json | 27 + .../ConfigurationAssignments_ListParent.json | 29 + ...nanceConfigurationsResourceGroup_List.json | 32 + ...figurations_CreateOrUpdateForResource.json | 63 + ...nanceConfigurations_DeleteForResource.json | 21 + ...ntenanceConfigurations_GetForResource.json | 29 + ...ions_GetForResource_GuestOSPatchLinux.json | 45 + ...ns_GetForResource_GuestOSPatchWindows.json | 44 + .../MaintenanceConfigurations_List.json | 31 + ...nanceConfigurations_UpdateForResource.json | 44 + .../2023-04-01/examples/Operations_List.json | 12 + ...ntenanceConfigurations_GetForResource.json | 28 + .../PublicMaintenanceConfigurations_List.json | 31 + .../2023-04-01/examples/Updates_List.json | 28 + .../examples/Updates_ListParent.json | 30 + .../resource-manager/readme.cli.md | 57 + .../maintenance/resource-manager/readme.md | 60 +- 39 files changed, 4545 insertions(+), 1 deletion(-) create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json create mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json new file mode 100644 index 000000000000..add55f4b3dd6 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json @@ -0,0 +1,3040 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01", + "title": "MaintenanceManagementClient", + "description": "Azure Maintenance Management Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations": { + "get": { + "tags": [ + "PublicMaintenanceConfigurations" + ], + "summary": "Get Public Maintenance Configuration records", + "operationId": "PublicMaintenanceConfigurations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListMaintenanceConfigurationsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "PublicMaintenanceConfigurations_List": { + "$ref": "./examples/PublicMaintenanceConfigurations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/{resourceName}": { + "get": { + "tags": [ + "PublicMaintenanceConfigurations" + ], + "summary": "Get Public Maintenance Configuration record", + "operationId": "PublicMaintenanceConfigurations_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceName", + "in": "path", + "description": "Maintenance Configuration Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "PublicMaintenanceConfigurations_GetForResource": { + "$ref": "./examples/PublicMaintenanceConfigurations_GetForResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}": { + "get": { + "tags": [ + "ApplyUpdates" + ], + "summary": "Track Updates to resource with parent", + "description": "Track maintenance updates to resource with parent", + "operationId": "ApplyUpdates_GetParent", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "applyUpdateName", + "in": "path", + "description": "applyUpdate Id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ApplyUpdates_GetParent": { + "$ref": "./examples/ApplyUpdates_GetParent.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}": { + "get": { + "tags": [ + "ApplyUpdates" + ], + "summary": "Track Updates to resource", + "description": "Track maintenance updates to resource", + "operationId": "ApplyUpdates_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "applyUpdateName", + "in": "path", + "description": "applyUpdate Id", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ApplyUpdates_Get": { + "$ref": "./examples/ApplyUpdates_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default": { + "put": { + "tags": [ + "ApplyUpdates" + ], + "summary": "Apply Updates to resource with parent", + "description": "Apply maintenance updates to resource with parent", + "operationId": "ApplyUpdates_CreateOrUpdateParent", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "201": { + "description": "Apply-update create request accepted", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ApplyUpdates_CreateOrUpdateParent": { + "$ref": "./examples/ApplyUpdates_CreateOrUpdateParent.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default": { + "put": { + "tags": [ + "ApplyUpdates" + ], + "summary": "Apply Updates to resource", + "description": "Apply maintenance updates to resource", + "operationId": "ApplyUpdates_CreateOrUpdate", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "201": { + "description": "ApplyUpdate create request accepted", + "schema": { + "$ref": "#/definitions/ApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ApplyUpdates_CreateOrUpdate": { + "$ref": "./examples/ApplyUpdates_CreateOrUpdate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Get configuration assignment", + "description": "Get configuration assignment for resource..", + "operationId": "ConfigurationAssignments_GetParent", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_GetParent": { + "$ref": "./examples/ConfigurationAssignments_GetParent.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignments_CreateOrUpdateParent", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "201": { + "description": "Configuration assignment create request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_CreateOrUpdateParent": { + "$ref": "./examples/ConfigurationAssignments_CreateOrUpdateParent.json" + } + } + }, + "delete": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Unregister configuration for resource", + "description": "Unregister configuration for resource.", + "operationId": "ConfigurationAssignments_DeleteParent", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Unique configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_DeleteParent": { + "$ref": "./examples/ConfigurationAssignments_DeleteParent.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Get configuration assignment", + "description": "Get configuration assignment for resource..", + "operationId": "ConfigurationAssignments_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_Get": { + "$ref": "./examples/ConfigurationAssignments_Get.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignments_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "201": { + "description": "Configuration assignment create request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_CreateOrUpdate": { + "$ref": "./examples/ConfigurationAssignments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Unregister configuration for resource", + "description": "Unregister configuration for resource.", + "operationId": "ConfigurationAssignments_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Unique configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_Delete": { + "$ref": "./examples/ConfigurationAssignments_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "List configurationAssignments for resource", + "description": "List configurationAssignments for resource.", + "operationId": "ConfigurationAssignments_ListParent", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListConfigurationAssignmentsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ConfigurationAssignments_ListParent": { + "$ref": "./examples/ConfigurationAssignments_ListParent.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "List configurationAssignments for resource", + "description": "List configurationAssignments for resource.", + "operationId": "ConfigurationAssignments_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListConfigurationAssignmentsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ConfigurationAssignments_List": { + "$ref": "./examples/ConfigurationAssignments_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations/{resourceName}": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Get Configuration record", + "operationId": "MaintenanceConfigurations_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Maintenance Configuration Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "MaintenanceConfigurations_GetForResource": { + "$ref": "./examples/MaintenanceConfigurations_GetForResource.json" + }, + "MaintenanceConfigurations_GetForResource_GuestOSPatchWindows": { + "$ref": "./examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json" + }, + "MaintenanceConfigurations_GetForResource_GuestOSPatchLinux": { + "$ref": "./examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json" + } + } + }, + "put": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Create or Update configuration record", + "operationId": "MaintenanceConfigurations_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Maintenance Configuration Name", + "required": true, + "type": "string" + }, + { + "name": "configuration", + "in": "body", + "description": "The configuration", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "201": { + "description": "Maintenance configuration create request accepted", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "MaintenanceConfigurations_CreateOrUpdateForResource": { + "$ref": "./examples/MaintenanceConfigurations_CreateOrUpdateForResource.json" + } + } + }, + "delete": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Delete Configuration record", + "operationId": "MaintenanceConfigurations_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Maintenance Configuration Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "MaintenanceConfigurations_DeleteForResource": { + "$ref": "./examples/MaintenanceConfigurations_DeleteForResource.json" + } + } + }, + "patch": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Patch configuration record", + "operationId": "MaintenanceConfigurations_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Maintenance Configuration Name", + "required": true, + "type": "string" + }, + { + "name": "configuration", + "in": "body", + "description": "The configuration", + "required": true, + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "MaintenanceConfigurations_UpdateForResource": { + "$ref": "./examples/MaintenanceConfigurations_UpdateForResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Get Configuration records within a subscription", + "operationId": "MaintenanceConfigurations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListMaintenanceConfigurationsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "MaintenanceConfigurations_List": { + "$ref": "./examples/MaintenanceConfigurations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations": { + "get": { + "tags": [ + "MaintenanceConfigurations" + ], + "summary": "Get Configuration records within a subscription and resource group", + "operationId": "MaintenanceConfigurationsForResourceGroup_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListMaintenanceConfigurationsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "MaintenanceConfigurationsResourceGroup_List": { + "$ref": "./examples/MaintenanceConfigurationsResourceGroup_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/applyUpdates": { + "get": { + "tags": [ + "ApplyUpdate" + ], + "summary": "Get Configuration records within a subscription", + "operationId": "ApplyUpdates_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ApplyUpdates_List": { + "$ref": "./examples/ApplyUpdates_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/applyUpdates": { + "get": { + "tags": [ + "ApplyUpdate" + ], + "summary": "Get Configuration records within a subscription and resource group", + "operationId": "ApplyUpdateForResourceGroup_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource Group Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListApplyUpdate" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ApplyUpdatesResourceGroup_List": { + "$ref": "./examples/ApplyUpdatesResourceGroup_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/configurationAssignments": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Get configuration assignment within a subscription", + "operationId": "ConfigurationAssignmentsWithinSubscription_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListConfigurationAssignmentsResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ConfigurationAssignmentsResultWithinSubscription_List": { + "$ref": "./examples/ConfigurationAssignmentsResultWithinSubscription_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Get configuration assignment", + "description": "Get configuration assignment for resource..", + "operationId": "ConfigurationAssignmentsForSubscriptions_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignments_GetParent": { + "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_Get.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignmentsForSubscriptions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "201": { + "description": "Configuration assignment create request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForSubscriptions_CreateOrUpdate": { + "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignmentsForSubscriptions_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForSubscriptions_CreateOrUpdate": { + "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json" + } + } + }, + "delete": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Unregister configuration for resource", + "description": "Unregister configuration for resource.", + "operationId": "ConfigurationAssignmentsForSubscriptions_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Unique configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForSubscriptions_Delete": { + "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { + "get": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Get configuration assignment", + "description": "Get configuration assignment for resource..", + "operationId": "ConfigurationAssignmentsForResourceGroup_Get", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string", + "pattern": "^.+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForResourceGroup_Get": { + "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_Get.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignmentsForResourceGroup_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "201": { + "description": "Configuration assignment create request accepted", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForResourceGroup_CreateOrUpdate": { + "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json" + } + } + }, + "patch": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Create configuration assignment", + "description": "Register configuration for resource.", + "operationId": "ConfigurationAssignmentsForResourceGroup_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Configuration assignment name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignment", + "in": "body", + "description": "The configurationAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForResourceGroup_CreateOrUpdate": { + "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json" + } + } + }, + "delete": { + "tags": [ + "ConfigurationAssignments" + ], + "summary": "Unregister configuration for resource", + "description": "Unregister configuration for resource.", + "operationId": "ConfigurationAssignmentsForResourceGroup_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "configurationAssignmentName", + "in": "path", + "description": "Unique configuration assignment name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConfigurationAssignment" + } + }, + "204": { + "description": "No Content" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-examples": { + "ConfigurationAssignmentsForResourceGroup_Delete": { + "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_Delete.json" + } + } + } + }, + "/providers/Microsoft.Maintenance/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "List available operations", + "description": "List the available operations supported by the Microsoft.Maintenance resource provider", + "operationId": "Operations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates": { + "get": { + "tags": [ + "Updates" + ], + "summary": "Get Updates to resource", + "description": "Get updates to resources.", + "operationId": "Updates_ListParent", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceParentType", + "in": "path", + "description": "Resource parent type", + "required": true, + "type": "string" + }, + { + "name": "resourceParentName", + "in": "path", + "description": "Resource parent identifier", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUpdatesResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Updates_ListParent": { + "$ref": "./examples/Updates_ListParent.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates": { + "get": { + "tags": [ + "Updates" + ], + "summary": "Get Updates to resource", + "description": "Get updates to resources.", + "operationId": "Updates_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "Resource group name", + "required": true, + "type": "string" + }, + { + "name": "providerName", + "in": "path", + "description": "Resource provider name", + "required": true, + "type": "string" + }, + { + "name": "resourceType", + "in": "path", + "description": "Resource type", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Resource identifier", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUpdatesResult" + } + }, + "default": { + "description": "BadRequest", + "schema": { + "$ref": "#/definitions/MaintenanceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Updates_List": { + "$ref": "./examples/Updates_List.json" + } + } + } + } + }, + "definitions": { + "ApplyUpdateProperties": { + "description": "Properties for apply update", + "type": "object", + "properties": { + "status": { + "description": "The status", + "enum": [ + "Pending", + "InProgress", + "Completed", + "RetryNow", + "RetryLater" + ], + "type": "string", + "x-ms-enum": { + "name": "UpdateStatus", + "modelAsString": true, + "values": [ + { + "value": "Pending", + "description": "There are pending updates to be installed." + }, + { + "value": "InProgress", + "description": "Updates installation are in progress." + }, + { + "value": "Completed", + "description": "All updates are successfully applied." + }, + { + "value": "RetryNow", + "description": "Updates installation failed but are ready to retry again." + }, + { + "value": "RetryLater", + "description": "Updates installation failed and should be retried later." + } + ] + } + }, + "resourceId": { + "description": "The resourceId", + "type": "string" + }, + "lastUpdateTime": { + "format": "date-time", + "description": "Last Update time", + "type": "string" + } + } + }, + "Resource": { + "description": "Definition of a Resource", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of the resource", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the resource", + "type": "string", + "readOnly": true + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" + } + }, + "x-ms-azure-resource": true + }, + "ApplyUpdate": { + "description": "Apply Update request", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ApplyUpdateProperties", + "description": "Properties of the apply update", + "x-ms-client-flatten": true + } + } + }, + "ListApplyUpdate": { + "description": "Response for ApplyUpdate list", + "type": "object", + "properties": { + "value": { + "description": "The list of apply updates", + "type": "array", + "items": { + "$ref": "#/definitions/ApplyUpdate" + } + } + } + }, + "ConfigurationAssignmentFilterProperties": { + "type": "object", + "description": "Azure query for the update configuration.", + "properties": { + "resourceTypes": { + "type": "array", + "description": "List of allowed resources.", + "items": { + "type": "string", + "description": "List of allowed resources" + } + }, + "resourceGroups": { + "type": "array", + "description": "List of allowed resource groups.", + "items": { + "type": "string", + "description": "List of allowed resource groups" + } + }, + "osTypes": { + "type": "array", + "description": "List of allowed operating systems.", + "items": { + "type": "string", + "description": "List of allowed operating systems" + } + }, + "locations": { + "type": "array", + "description": "List of locations to scope the query to.", + "items": { + "type": "string", + "description": "Location to scope the query to." + } + }, + "tagSettings": { + "type": "object", + "description": "Tag settings for the VM.", + "$ref": "#/definitions/TagSettingsProperties" + } + } + }, + "TagSettingsProperties": { + "type": "object", + "description": "Tag filter information for the VM.", + "properties": { + "tags": { + "type": "object", + "description": "Dictionary of tags with its list of values.", + "additionalProperties": { + "type": "array", + "items": { + "type": "string", + "description": "List of tag values for a tag." + } + } + }, + "filterOperator": { + "type": "string", + "description": "Filter VMs by Any or All specified tags.", + "enum": [ + "All", + "Any" + ], + "x-ms-enum": { + "name": "TagOperators", + "modelAsString": false + } + } + } + }, + "ConfigurationAssignmentProperties": { + "description": "Properties for configuration assignment", + "type": "object", + "properties": { + "maintenanceConfigurationId": { + "description": "The maintenance configuration Id", + "type": "string" + }, + "resourceId": { + "description": "The unique resourceId", + "type": "string" + }, + "filter": { + "$ref": "#/definitions/ConfigurationAssignmentFilterProperties", + "description": "Properties of the configuration assignment" + } + } + }, + "ConfigurationAssignment": { + "description": "Configuration Assignment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Location of the resource", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ConfigurationAssignmentProperties", + "description": "Properties of the configuration assignment", + "x-ms-client-flatten": true + } + } + }, + "ListConfigurationAssignmentsResult": { + "description": "Response for ConfigurationAssignments list", + "type": "object", + "properties": { + "value": { + "description": "The list of configuration Assignments", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationAssignment" + } + } + } + }, + "MaintenanceWindow": { + "description": "Definition of a MaintenanceWindow", + "type": "object", + "properties": { + "startDateTime": { + "description": "Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone.", + "type": "string" + }, + "expirationDateTime": { + "description": "Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59.", + "type": "string" + }, + "duration": { + "description": "Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00.", + "type": "string" + }, + "timeZone": { + "description": "Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time.", + "type": "string" + }, + "recurEvery": { + "description": "Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6.", + "type": "string" + } + } + }, + "MaintenanceConfigurationProperties": { + "description": "Properties for maintenance configuration", + "type": "object", + "properties": { + "namespace": { + "description": "Gets or sets namespace of the resource", + "type": "string" + }, + "extensionProperties": { + "description": "Gets or sets extensionProperties of the maintenanceConfiguration", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "maintenanceScope": { + "description": "Gets or sets maintenanceScope of the configuration", + "enum": [ + "Host", + "Resource", + "OSImage", + "Extension", + "InGuestPatch", + "SQLDB", + "SQLManagedInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "MaintenanceScope", + "modelAsString": true, + "values": [ + { + "value": "Host", + "description": "This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs." + }, + { + "value": "Resource", + "description": "This maintenance scope controls the default update maintenance of the Azure Resource" + }, + { + "value": "OSImage", + "description": "This maintenance scope controls os image installation on VM/VMSS" + }, + { + "value": "Extension", + "description": "This maintenance scope controls extension installation on VM/VMSS" + }, + { + "value": "InGuestPatch", + "description": "This maintenance scope controls installation of windows and linux packages on VM/VMSS" + }, + { + "value": "SQLDB", + "description": "This maintenance scope controls installation of SQL server platform updates." + }, + { + "value": "SQLManagedInstance", + "description": "This maintenance scope controls installation of SQL managed instance platform update." + } + ] + } + }, + "maintenanceWindow": { + "$ref": "#/definitions/MaintenanceWindow", + "description": "Definition of a MaintenanceWindow", + "x-ms-client-flatten": true + }, + "visibility": { + "description": "Gets or sets the visibility of the configuration. The default value is 'Custom'", + "enum": [ + "Custom", + "Public" + ], + "type": "string", + "x-ms-enum": { + "name": "Visibility", + "modelAsString": true, + "values": [ + { + "value": "Custom", + "description": "Only visible to users with permissions." + }, + { + "value": "Public", + "description": "Visible to all users." + } + ] + } + }, + "installPatches": { + "$ref": "#/definitions/InputPatchConfiguration", + "description": "The input parameters to be passed to the patch run operation." + } + } + }, + "InputPatchConfiguration": { + "type": "object", + "properties": { + "rebootSetting": { + "type": "string", + "enum": [ + "IfRequired", + "Never", + "Always" + ], + "x-ms-enum": { + "name": "RebootOptions", + "modelAsString": true + }, + "default": "IfRequired", + "description": "Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed." + }, + "windowsParameters": { + "$ref": "#/definitions/InputWindowsParameters", + "description": "Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property." + }, + "linuxParameters": { + "$ref": "#/definitions/InputLinuxParameters", + "description": "Input parameters specific to patching Linux machine. For Windows machines, do not pass this property." + } + }, + "description": "Input configuration for a patch run" + }, + "InputWindowsParameters": { + "type": "object", + "properties": { + "kbNumbersToExclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Windows KBID to be excluded for patching." + }, + "kbNumbersToInclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Windows KBID to be included for patching." + }, + "classificationsToInclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Classification category of patches to be patched" + }, + "excludeKbsRequiringReboot": { + "type": "boolean", + "description": "Exclude patches which need reboot" + } + }, + "description": "Input properties for patching a Windows machine." + }, + "InputLinuxParameters": { + "type": "object", + "properties": { + "packageNameMasksToExclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Package names to be excluded for patching." + }, + "packageNameMasksToInclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Package names to be included for patching." + }, + "classificationsToInclude": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Classification category of patches to be patched" + } + }, + "description": "Input properties for patching a Linux machine." + }, + "MaintenanceConfiguration": { + "description": "Maintenance configuration record type", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Gets or sets location of the resource", + "type": "string" + }, + "tags": { + "description": "Gets or sets tags of the resource", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/MaintenanceConfigurationProperties", + "description": "Gets or sets properties of the resource", + "x-ms-client-flatten": true + } + } + }, + "MaintenanceError": { + "description": "An error response received from the Azure Maintenance service.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDetails", + "description": "Details of the error" + } + } + }, + "ErrorDetails": { + "description": "An error response details received from the Azure Maintenance service.", + "type": "object", + "properties": { + "code": { + "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.", + "type": "string" + }, + "message": { + "description": "Human-readable representation of the error.", + "type": "string" + } + } + }, + "ListMaintenanceConfigurationsResult": { + "description": "Response for MaintenanceConfigurations list", + "type": "object", + "properties": { + "value": { + "description": "The list of maintenance Configurations", + "type": "array", + "items": { + "$ref": "#/definitions/MaintenanceConfiguration" + } + } + } + }, + "OperationsListResult": { + "description": "Result of the List Operations operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ] + } + } + }, + "Operation": { + "description": "Represents an operation returned by the GetOperations request", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationInfo", + "description": "Display name of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "description": "Properties of the operation", + "type": "object", + "x-ms-client-flatten": true + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + } + }, + "OperationInfo": { + "description": "Information about an operation", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider", + "type": "string" + }, + "resource": { + "description": "Name of the resource type", + "type": "string" + }, + "operation": { + "description": "Name of the operation", + "type": "string" + }, + "description": { + "description": "Description of the operation", + "type": "string" + } + } + }, + "ListUpdatesResult": { + "description": "Response for Updates list", + "type": "object", + "properties": { + "value": { + "description": "The pending updates", + "type": "array", + "items": { + "$ref": "#/definitions/Update" + }, + "x-ms-identifiers": [] + } + } + }, + "Update": { + "description": "Maintenance update on a resource", + "type": "object", + "properties": { + "maintenanceScope": { + "description": "The impact area", + "enum": [ + "Host", + "Resource", + "OSImage", + "Extension", + "InGuestPatch", + "SQLDB", + "SQLManagedInstance" + ], + "type": "string", + "x-ms-enum": { + "name": "MaintenanceScope", + "modelAsString": true, + "values": [ + { + "value": "Host", + "description": "This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs." + }, + { + "value": "Resource", + "description": "This maintenance scope controls the default update maintenance of the Azure Resource" + }, + { + "value": "OSImage", + "description": "This maintenance scope controls os image installation on VM/VMSS" + }, + { + "value": "Extension", + "description": "This maintenance scope controls extension installation on VM/VMSS" + }, + { + "value": "InGuestPatch", + "description": "This maintenance scope controls installation of windows and linux packages on VM/VMSS" + }, + { + "value": "SQLDB", + "description": "This maintenance scope controls installation of SQL server platform updates." + }, + { + "value": "SQLManagedInstance", + "description": "This maintenance scope controls installation of SQL managed instance platform update." + } + ] + } + }, + "impactType": { + "description": "The impact type", + "enum": [ + "None", + "Freeze", + "Restart", + "Redeploy" + ], + "type": "string", + "x-ms-enum": { + "name": "ImpactType", + "modelAsString": true, + "values": [ + { + "value": "None", + "description": "Pending updates has no impact on resource." + }, + { + "value": "Freeze", + "description": "Pending updates can freeze network or disk io operation on resource." + }, + { + "value": "Restart", + "description": "Pending updates can cause resource to restart." + }, + { + "value": "Redeploy", + "description": "Pending updates can redeploy resource." + } + ] + } + }, + "status": { + "description": "The status", + "enum": [ + "Pending", + "InProgress", + "Completed", + "RetryNow", + "RetryLater" + ], + "type": "string", + "x-ms-enum": { + "name": "UpdateStatus", + "modelAsString": true, + "values": [ + { + "value": "Pending", + "description": "There are pending updates to be installed." + }, + { + "value": "InProgress", + "description": "Updates installation are in progress." + }, + { + "value": "Completed", + "description": "All updates are successfully applied." + }, + { + "value": "RetryNow", + "description": "Updates installation failed but are ready to retry again." + }, + { + "value": "RetryLater", + "description": "Updates installation failed and should be retried later." + } + ] + } + }, + "impactDurationInSec": { + "format": "int32", + "description": "Duration of impact in seconds", + "type": "integer" + }, + "notBefore": { + "format": "date-time", + "description": "Time when Azure will start force updates if not self-updated by customer before this time", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/UpdateProperties", + "description": "Properties of the apply update", + "x-ms-client-flatten": true + } + } + }, + "UpdateProperties": { + "description": "Properties for update", + "type": "object", + "properties": { + "resourceId": { + "description": "The resourceId", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of the API to be used with the client request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + } + }, + "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" + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json new file mode 100644 index 000000000000..cd68c3164dd9 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Maintenance", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", + "status": "Completed" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json new file mode 100644 index 000000000000..033b3b9c6c46 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", + "status": "Pending" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", + "status": "Pending" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json new file mode 100644 index 000000000000..a001eb591eda --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdvm1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1", + "status": "Pending" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1", + "status": "Pending" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json new file mode 100644 index 000000000000..d09ac9b2d231 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "applyUpdateName": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", + "status": "Completed" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json new file mode 100644 index 000000000000..b1b99728c9c5 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdvm1", + "applyUpdateName": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1", + "status": "Completed" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json new file mode 100644 index 000000000000..063401144973 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "providerName": "Microsoft.Maintenance", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", + "type": "Microsoft.Maintenance/applyUpdates", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", + "status": "Completed" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json new file mode 100644 index 000000000000..2734f84cedf5 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg", + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "osTypes": [ + "Windows", + "Linux" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg", + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json new file mode 100644 index 000000000000..c10ba96f4137 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments" + } + }, + "204": {}, + "202": {} + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json new file mode 100644 index 000000000000..b1e6d6dd32f3 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "All" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json new file mode 100644 index 000000000000..cb3f11dabc9c --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json new file mode 100644 index 000000000000..eb829877dc09 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "resourceGroups": [ + "RG1", + "RG2" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "resourceGroups": [ + "RG1", + "RG2" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "resourceGroups": [ + "RG1", + "RG2" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json new file mode 100644 index 000000000000..6ed5b0bbebd7 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments" + } + }, + "204": {}, + "202": {} + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json new file mode 100644 index 000000000000..e967df973f8e --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "All" + }, + "locations": [ + "Japan East", + "UK South" + ] + }, + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json new file mode 100644 index 000000000000..466240c709cc --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "resourceGroups": [ + "RG1", + "RG2" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "filter": { + "resourceTypes": [ + "Microsoft.HybridCompute/machines", + "Microsoft.Compute/virtualMachines" + ], + "resourceGroups": [ + "RG1", + "RG2" + ], + "tagSettings": { + "tags": { + "tag1": [ + "tag1Value1", + "tag1Value2", + "tag1Value3" + ], + "tag2": [ + "tag2Value1", + "tag2Value2", + "tag2Value3" + ] + }, + "filterOperator": "Any" + }, + "locations": [ + "Japan East", + "UK South" + ] + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json new file mode 100644 index 000000000000..4d8553b74212 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "providerName": "Microsoft.Maintenance", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json new file mode 100644 index 000000000000..e1a48bb1df9a --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json new file mode 100644 index 000000000000..90379b5f9355 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdvm1", + "configurationAssignmentName": "workervmPolicy", + "api-version": "2023-04-01", + "configurationAssignment": { + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", + "name": "workervmPolicy", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", + "name": "workervmPolicy", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json new file mode 100644 index 000000000000..a85db48b8f6b --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments" + } + }, + "204": {} + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json new file mode 100644 index 000000000000..b908aac66f4b --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdvm1", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments" + } + }, + "204": {} + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json new file mode 100644 index 000000000000..901fd7a6c61c --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "configurationAssignmentName": "workervmConfiguration", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json new file mode 100644 index 000000000000..f86089fa0766 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdvm1", + "configurationAssignmentName": "workervmPolicy", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", + "name": "workervmPolicy", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1" + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json new file mode 100644 index 000000000000..6f04597d4763 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", + "name": "workervmConfiguration", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json new file mode 100644 index 000000000000..7a21a5852970 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "smdtestvm1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdtestvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", + "name": "workervmPolicy", + "type": "Microsoft.Maintenance/configurationAssignments", + "properties": { + "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdtestvm1" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json new file mode 100644 index 000000000000..7f19b3dff9ab --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "OSImage", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Week Saturday,Sunday" + } + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json new file mode 100644 index 000000000000..101c9375b0cf --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "configuration1", + "api-version": "2023-04-01", + "configuration": { + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "visibility": "Custom", + "maintenanceScope": "OSImage", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Day" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "visibility": "Custom", + "maintenanceScope": "OSImage", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Day" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "visibility": "Custom", + "maintenanceScope": "OSImage", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Day" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json new file mode 100644 index 000000000000..b542151adb94 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "example1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance" + } + } + }, + "204": {} + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json new file mode 100644 index 000000000000..469d307bcf79 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "configuration1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "OSImage", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "5Days" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json new file mode 100644 index 000000000000..cb34ac5c9869 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "configuration1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "InGuestPatch", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "5Days" + }, + "installPatches": { + "linuxParameters": { + "classificationsToInclude": [ + "Critical" + ], + "packageNameMasksToExclude": [ + "apt", + "http" + ], + "packageNameMasksToInclude": [ + "binutils", + "bin" + ] + }, + "rebootSetting": "Always" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json new file mode 100644 index 000000000000..381f3a0f9eef --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "configuration1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "InGuestPatch", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "5Days" + }, + "installPatches": { + "windowsParameters": { + "classificationsToInclude": [ + "Security" + ], + "kbNumbersToInclude": [ + "KB123456" + ], + "kbNumbersToExclude": [ + "KB234567" + ], + "excludeKbsRequiringReboot": false + }, + "rebootSetting": "Always" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json new file mode 100644 index 000000000000..d05c74071df8 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "OSImage", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Week Saturday,Sunday" + } + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json new file mode 100644 index 000000000000..e9055dfafa0d --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "resourceName": "configuration1", + "api-version": "2023-04-01", + "configuration": { + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "visibility": "Custom", + "maintenanceScope": "OSImage", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Month Third Sunday" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "OSImage", + "visibility": "Custom", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Month Third Sunday" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json new file mode 100644 index 000000000000..77c3ae6d7e29 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json new file mode 100644 index 000000000000..03b7d9387f4a --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceName": "configuration1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "SQLDB", + "visibility": "Public", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00", + "expirationDateTime": "9999-12-31 00:00", + "duration": "05:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "2Weeks" + } + } + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json new file mode 100644 index 000000000000..9582630da1ca --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1", + "name": "configuration1", + "location": "westus2", + "properties": { + "namespace": "Microsoft.Maintenance", + "maintenanceScope": "SQLDB", + "visibility": "Public", + "maintenanceWindow": { + "startDateTime": "2020-04-30 08:00:00", + "expirationDateTime": "9999-12-31 00:00:00", + "duration": "05:00:00", + "timeZone": "Pacific Standard Time", + "recurEvery": "Week Saturday,Sunday" + } + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json new file mode 100644 index 000000000000..47d012abf1f6 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceType": "virtualMachineScaleSets", + "resourceName": "smdtest1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "maintenanceScope": "Resource", + "status": "Pending", + "impactType": "Reboot", + "impactDurationInSec": 1440, + "notBefore": "2018-10-09T06:17:44.235Z", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json new file mode 100644 index 000000000000..803de75968f0 --- /dev/null +++ b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerName": "Microsoft.Compute", + "resourceParentType": "virtualMachineScaleSets", + "resourceParentName": "smdtest1", + "resourceType": "virtualMachines", + "resourceName": "1", + "api-version": "2023-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "maintenanceScope": "Resource", + "status": "Pending", + "impactType": "Reboot", + "impactDurationInSec": 1440, + "notBefore": "2018-10-09T06:17:44.235Z", + "properties": { + "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/1" + } + } + ] + } + } + } +} diff --git a/specification/maintenance/resource-manager/readme.cli.md b/specification/maintenance/resource-manager/readme.cli.md index 0327c7451143..784dfcef420a 100644 --- a/specification/maintenance/resource-manager/readme.cli.md +++ b/specification/maintenance/resource-manager/readme.cli.md @@ -6,4 +6,61 @@ These settings apply only when `--cli` is specified on the command line. cli: namespace: azure.mgmt.maintenance flatten-all: true + cli-directive: + - select: 'operationGroup' + where: + operationGroup: 'ApplyUpdateForResourceGroup' + hidden: true + - where: + operationGroup: 'MaintenanceConfigurationsForResourceGroup' + hidden: true + - where: + operationGroup: 'ConfigurationAssignmentsWithinSubscription' + hidden: true + - select: 'parameter' + where: + parameter: duration + alias: + - maintenance-window-duration + - duration + - where: + parameter: 'expirationDateTime' + alias: + - maintenance-window-expiration-date-time + - expiration-date-time + - where: + parameter: 'recurEvery' + alias: + - maintenance-window-recur-every + - recur-every + - where: + param: startDateTime + alias: + - maintenance-window-start-date-time + - start-date-time + - where: + param: timeZone + alias: + - maintenance-window-time-zone + - time-zone + - where: + param: linuxParameters + alias: + - install-patches-linux-parameters + - linux-parameters + - where: + param: windowsParameters + alias: + - install-patches-windows-parameters + - windows-parameters + - where: + param: postTasks + alias: + - install-patches-post-tasks + - post-tasks + - where: + param: preTasks + alias: + - install-patches-pre-tasks + - pre-tasks ``` diff --git a/specification/maintenance/resource-manager/readme.md b/specification/maintenance/resource-manager/readme.md index 44bc36144a1f..59222a780ca0 100644 --- a/specification/maintenance/resource-manager/readme.md +++ b/specification/maintenance/resource-manager/readme.md @@ -26,9 +26,17 @@ These are the global settings for the Azure Maintenance API. ``` yaml openapi-type: arm -tag: package-preview-2022-11 +tag: package-2023-04 ``` +### Tag: package-2023-04 + +These settings apply only when `--tag=package-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-2023-04' +input-file: + - Microsoft.Maintenance/stable/2023-04-01/Maintenance.json +``` ### Tag: package-preview-2022-11 @@ -38,6 +46,7 @@ These settings apply only when `--tag=package-preview-2022-11` is specified on t input-file: - Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json ``` + ### Tag: package-preview-2022-07 These settings apply only when `--tag=package-preview-2022-07` is specified on the command line. @@ -146,3 +155,52 @@ See configuration in [readme.go.md](./readme.go.md) ## Java See configuration in [readme.java.md](./readme.java.md) + +### Suppression + +``` yaml +directive: + - suppress: PathForPutOperation + from: maintenance.json + reason: Subscription or resource group is passed in request body. + - suppress: DeleteResponseBodyEmpty + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: PathContainsResourceType + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: PathContainsResourceType + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: TrackedResourcePatchOperation + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: SubscriptionsAndResourceGroupCasing + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: UnSupportedPatchProperties + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: PathResourceProviderNamePascalCase + from: maintenance.json + reason: Suppression warning to avoid breaking changes + - suppress: RequestSchemaForTrackedResourcesMustHaveTags + from: maintenance.json + reason: False positive. ConfigurationAssignments is proxy resource at subscription/resourceGroup level. + - suppress: ResourceNameRestriction + from: maintenance.json + reason: Maintenance RP accept any string, no special restriction required. + - suppress: PutResponseSchemaDescription + from: maintenance.json + reason: No documentation changes. + - suppress: DeleteOperationAsyncResponseValidation + from: maintenance.json + reason: No async operation supported by Mantenance RP. + - suppress: LroLocationHeader + from: maintenance.json + reason: No async operation supported by Mantenance RP. + - suppress: LroErrorContent + from: maintenance.json + reason: No documentation changes. +``` + From 1b652b3d1890d86fb8658e7a9a70ed3863d2492d Mon Sep 17 00:00:00 2001 From: jsedlak-microsoft <65620804+jsedlak-microsoft@users.noreply.github.com> Date: Mon, 8 May 2023 11:53:27 -0400 Subject: [PATCH 42/79] Update security description and examples for Search service (#23797) * Update descriptions in the security section of search.json * Update security description in 2021-11-01-preview/geocoding.json * Update security description 2022-02-01-preview/geocoding.json * Update ForwardGeocodingByAddressLine to include countryRegion filter * Update security description in 2022-09-01-preview/search.json * Update ForwardGeocodingByAddressLine.json * Update security description for 2022-12-01-preview/search.json * Update ForwardGeocodingByAddressLine.json * Update security note format * Add trailing newlines * Update note formating * Add newlines * Update note formating * Update note formating * Update note formating * Update ForwardGeocodingByAddressLine.json * Update ForwardGeocodingByAddressLine.json * Update ForwardGeocodingByAddressLine.json * Update ForwardGeocodingByAddressLine.json --- specification/maps/data-plane/Search/preview/1.0/search.json | 2 +- .../examples/ForwardGeocodingByAddressLine.json | 1 + .../data-plane/Search/preview/2021-11-01-preview/geocoding.json | 2 +- .../examples/ForwardGeocodingByAddressLine.json | 1 + .../data-plane/Search/preview/2022-02-01-preview/geocoding.json | 2 +- .../examples/ForwardGeocodingByAddressLine.json | 1 + .../data-plane/Search/preview/2022-09-01-preview/search.json | 2 +- .../examples/ForwardGeocodingByAddressLine.json | 1 + .../data-plane/Search/preview/2022-12-01-preview/search.json | 2 +- 9 files changed, 9 insertions(+), 5 deletions(-) diff --git a/specification/maps/data-plane/Search/preview/1.0/search.json b/specification/maps/data-plane/Search/preview/1.0/search.json index 8f1e81d5aa20..0070978f05de 100644 --- a/specification/maps/data-plane/Search/preview/1.0/search.json +++ b/specification/maps/data-plane/Search/preview/1.0/search.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n> [!NOTE]\n> * This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n> * The Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.\n\n", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } diff --git a/specification/maps/data-plane/Search/preview/2021-11-01-preview/examples/ForwardGeocodingByAddressLine.json b/specification/maps/data-plane/Search/preview/2021-11-01-preview/examples/ForwardGeocodingByAddressLine.json index 2b3bcbf8ee47..c2650163f59a 100644 --- a/specification/maps/data-plane/Search/preview/2021-11-01-preview/examples/ForwardGeocodingByAddressLine.json +++ b/specification/maps/data-plane/Search/preview/2021-11-01-preview/examples/ForwardGeocodingByAddressLine.json @@ -2,6 +2,7 @@ "parameters": { "api-version": "2021-11-01-preview", "addressLine": "15127 NE 24th Street Redmond WA", + "countryRegionSet": "US", "AzureKey": "[subscription-key]" }, "responses": { diff --git a/specification/maps/data-plane/Search/preview/2021-11-01-preview/geocoding.json b/specification/maps/data-plane/Search/preview/2021-11-01-preview/geocoding.json index 7e41549fe65d..4deddcf21aad 100644 --- a/specification/maps/data-plane/Search/preview/2021-11-01-preview/geocoding.json +++ b/specification/maps/data-plane/Search/preview/2021-11-01-preview/geocoding.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n> [!NOTE]\n> * This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n> * The Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.\n\n", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } diff --git a/specification/maps/data-plane/Search/preview/2022-02-01-preview/examples/ForwardGeocodingByAddressLine.json b/specification/maps/data-plane/Search/preview/2022-02-01-preview/examples/ForwardGeocodingByAddressLine.json index b6406b8af78a..837200c2350f 100644 --- a/specification/maps/data-plane/Search/preview/2022-02-01-preview/examples/ForwardGeocodingByAddressLine.json +++ b/specification/maps/data-plane/Search/preview/2022-02-01-preview/examples/ForwardGeocodingByAddressLine.json @@ -2,6 +2,7 @@ "parameters": { "api-version": "2022-02-01-preview", "addressLine": "15127 NE 24th Street Redmond WA", + "countryRegionSet": "US", "AzureKey": "[subscription-key]" }, "responses": { diff --git a/specification/maps/data-plane/Search/preview/2022-02-01-preview/geocoding.json b/specification/maps/data-plane/Search/preview/2022-02-01-preview/geocoding.json index ca4cd137cf46..1c352f4dc633 100644 --- a/specification/maps/data-plane/Search/preview/2022-02-01-preview/geocoding.json +++ b/specification/maps/data-plane/Search/preview/2022-02-01-preview/geocoding.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n> [!NOTE]\n> * This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n> * The Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.\n\n", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } diff --git a/specification/maps/data-plane/Search/preview/2022-09-01-preview/examples/ForwardGeocodingByAddressLine.json b/specification/maps/data-plane/Search/preview/2022-09-01-preview/examples/ForwardGeocodingByAddressLine.json index b45080570448..36da9a069e01 100644 --- a/specification/maps/data-plane/Search/preview/2022-09-01-preview/examples/ForwardGeocodingByAddressLine.json +++ b/specification/maps/data-plane/Search/preview/2022-09-01-preview/examples/ForwardGeocodingByAddressLine.json @@ -2,6 +2,7 @@ "parameters": { "api-version": "2022-09-01-preview", "addressLine": "15127 NE 24th Street Redmond WA", + "countryRegionSet": "US", "AzureKey": "[subscription-key]" }, "responses": { diff --git a/specification/maps/data-plane/Search/preview/2022-09-01-preview/search.json b/specification/maps/data-plane/Search/preview/2022-09-01-preview/search.json index 548319286f19..6f9519ee9e5d 100644 --- a/specification/maps/data-plane/Search/preview/2022-09-01-preview/search.json +++ b/specification/maps/data-plane/Search/preview/2022-09-01-preview/search.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n> [!NOTE]\n> * This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n> * The Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.\n\n", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } diff --git a/specification/maps/data-plane/Search/preview/2022-12-01-preview/examples/ForwardGeocodingByAddressLine.json b/specification/maps/data-plane/Search/preview/2022-12-01-preview/examples/ForwardGeocodingByAddressLine.json index 85120725934f..bf230546c794 100644 --- a/specification/maps/data-plane/Search/preview/2022-12-01-preview/examples/ForwardGeocodingByAddressLine.json +++ b/specification/maps/data-plane/Search/preview/2022-12-01-preview/examples/ForwardGeocodingByAddressLine.json @@ -2,6 +2,7 @@ "parameters": { "api-version": "2022-12-01-preview", "addressLine": "15127 NE 24th Street Redmond WA", + "countryRegionSet": "US", "AzureKey": "[subscription-key]" }, "responses": { diff --git a/specification/maps/data-plane/Search/preview/2022-12-01-preview/search.json b/specification/maps/data-plane/Search/preview/2022-12-01-preview/search.json index 409892b057c2..c6a691b2c1f1 100644 --- a/specification/maps/data-plane/Search/preview/2022-12-01-preview/search.json +++ b/specification/maps/data-plane/Search/preview/2022-12-01-preview/search.json @@ -18,7 +18,7 @@ "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", - "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/en-us/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/en-us/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0](https://docs.microsoft.com/en-us/azure/active-directory/develop/azure-ad-endpoint-comparison) tokens are supported.", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n> [!NOTE]\n> * This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n> * The `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n> * The Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n> * Usage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n> * Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.\n\n", "scopes": { "https://atlas.microsoft.com/.default": "https://atlas.microsoft.com/.default" } From 2f7a3cbda00c6ae4199940d500e5212b6481d9ea Mon Sep 17 00:00:00 2001 From: Jimmy Campbell Date: Mon, 8 May 2023 11:21:32 -0700 Subject: [PATCH 43/79] [AppConfiguration][Unreleased] Update snapshot composition_type enum values. (#23801) * Update snapshot composition_type enum values. * Update ordering of composition_type property to reflect default value. --- .../preview/2022-11-01-preview/appconfiguration.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json index 6fa7e742bbb4..d1eb37ab2aa0 100644 --- a/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json +++ b/specification/appconfiguration/data-plane/Microsoft.AppConfiguration/preview/2022-11-01-preview/appconfiguration.json @@ -1617,11 +1617,11 @@ } }, "composition_type": { - "description": "The composition type describes how the key-values within the snapshot are composed. The 'all' composition type includes all key-values. The 'group_by_key' composition type ensures there are no two key-values containing the same key.", + "description": "The composition type describes how the key-values within the snapshot are composed. The 'key' composition type ensures there are no two key-values containing the same key. The 'key_label' composition type ensures there are no two key-values containing the same key and label.", "type": "string", "enum": [ - "all", - "group_by_key" + "key", + "key_label" ], "x-nullable": false, "x-ms-enum": { From 45349a680f7c658322db2ad38341509ab10b5f4e Mon Sep 17 00:00:00 2001 From: ni-bhandari <120053375+ni-bhandari@users.noreply.github.com> Date: Mon, 8 May 2023 11:34:27 -0700 Subject: [PATCH 44/79] Add swagger for UploadIndicatorsAPI (Data Plane) (#21808) * Add swagger for UploadIndicatorsAPI * Add readme * Update swagger * Update readme * Add to customWords * Update swagger with security def and example * prettier fix * Update example, swagger * Update examples * Fix swagger validation errors * run prettier * Add error suppressions * fix avocado * Minor changes * update swagger with new changes * Update URI and operation id * prettier fix * update error object * fix pr comment * Rename error object * Update descriptions * Change response objects * Validation test fix * update url * Add to custom words, change operation id --- custom-words.txt | 5 + .../ThreatIntelligence.json | 180 ++++++++++++++++++ .../UploadThreatIntelligence.json | 73 +++++++ .../securityinsights/data-plane/readme.md | 59 ++++++ 4 files changed, 317 insertions(+) create mode 100644 specification/securityinsights/data-plane/Microsoft.SecurityInsights/preview/2022-12-01-preview/ThreatIntelligence.json create mode 100644 specification/securityinsights/data-plane/Microsoft.SecurityInsights/preview/2022-12-01-preview/examples/threatintelligence/UploadThreatIntelligence.json create mode 100644 specification/securityinsights/data-plane/readme.md diff --git a/custom-words.txt b/custom-words.txt index aac05ed1eecc..31b49908018c 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1936,6 +1936,8 @@ securitydomaintransferkey securitydomainuploadoperation securityinsight seealso +Seleted +sentinelus seresnext serialconsole servercollectors @@ -2029,6 +2031,7 @@ sorani sortorder soundex sourcecontrols +sourcesystem southafricanorth southafricawest southcentralus @@ -2217,6 +2220,8 @@ TFIDF Tful Tfvc Thirdparty +threatintelligence +threatintelligenceindicators tilejson tileset tilesetconfiguration diff --git a/specification/securityinsights/data-plane/Microsoft.SecurityInsights/preview/2022-12-01-preview/ThreatIntelligence.json b/specification/securityinsights/data-plane/Microsoft.SecurityInsights/preview/2022-12-01-preview/ThreatIntelligence.json new file mode 100644 index 000000000000..1b3c6fdcab7b --- /dev/null +++ b/specification/securityinsights/data-plane/Microsoft.SecurityInsights/preview/2022-12-01-preview/ThreatIntelligence.json @@ -0,0 +1,180 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Sentinel Upload Indicators API", + "description": "Spec for Microsoft Sentinel Upload Indicators API.", + "version": "2022-12-01-preview" + }, + "host": "sentinelus.azure-api.net", + "schemes": [ + "https" + ], + "paths": { + "/workspaces/{workspaceId}/threatintelligenceindicators:upload": { + "post": { + "x-ms-examples": { + "Upload Threat Intelligence indicators": { + "$ref": "./examples/threatintelligence/UploadThreatIntelligence.json" + } + }, + "summary": "Upload the indicators to the workspace", + "description": "Upload the list of indicators to the workspace specified", + "operationId": "ThreatIntelligenceIndicators_Upload", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "in": "path", + "name": "workspaceId", + "description": "The workspace ID for the indicators to be uploaded.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "body", + "description": "Body of the request with an array of indicators and other properties", + "required": true, + "schema": { + "$ref": "#/definitions/UploadIndicatorsRequest" + } + } + ], + "responses": { + "200": { + "description": "The API returns 200 when at least one indicator is successfully validated and published.", + "schema": { + "$ref": "#/definitions/UploadIndicatorsResponse" + } + }, + "default": { + "description": "Upload Indicators API service error response.", + "schema": { + "$ref": "#/definitions/ErrorResponseBody" + }, + "x-ms-error-response": true + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] + } + } + }, + "definitions": { + "JsonPropertyBag": { + "description": "An object that stores a list of JSON properties from a given JObject.", + "type": "object" + }, + "UploadIndicatorsRequest": { + "description": "Schema for request body.", + "type": "object", + "properties": { + "sourcesystem": { + "description": "Source of the indicators to be uploaded. Source system name cannot be Microsoft Sentinel.", + "type": "string" + }, + "indicators": { + "description": "The indicators param is an array of STIX indictors. Indicators need to be in STIX format (STIX Indicator documentation). Indicators need to contain the “ID” field. We only support Stix 2.0 and 2.1 format.", + "type": "array", + "items": { + "$ref": "#/definitions/JsonPropertyBag" + } + } + } + }, + "UploadIndicatorsResponse": { + "description": "Response object containing more details about the operation.", + "type": "object", + "properties": { + "errors": { + "description": "Details of the error. Contains a list of indicator validation errors", + "type": "array", + "items": { + "$ref": "#/definitions/IndicatorValidationError" + } + } + } + }, + "IndicatorValidationError": { + "description": "Object that stores a list of errors encountered when executing the Upload Indicators operation.", + "type": "object", + "properties": { + "recordIndex": { + "format": "int64", + "description": "Index of the indicator in indicators array from request.", + "type": "integer" + }, + "validationErrorMessages": { + "description": "List of validation errors for a single indicator.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ErrorResponseBody": { + "description": "The definition of an error object.", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorData" + } + } + }, + "ErrorData": { + "description": "Detailed information about the errors from the operation.", + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "Server defined code for the error", + "type": "string" + }, + "message": { + "description": "Error message", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "in": "query", + "name": "api-version", + "description": "The api-version for operation", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } +} diff --git a/specification/securityinsights/data-plane/Microsoft.SecurityInsights/preview/2022-12-01-preview/examples/threatintelligence/UploadThreatIntelligence.json b/specification/securityinsights/data-plane/Microsoft.SecurityInsights/preview/2022-12-01-preview/examples/threatintelligence/UploadThreatIntelligence.json new file mode 100644 index 000000000000..56b0fd17131c --- /dev/null +++ b/specification/securityinsights/data-plane/Microsoft.SecurityInsights/preview/2022-12-01-preview/examples/threatintelligence/UploadThreatIntelligence.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2022-12-01-preview", + "workspaceId": "1c4dc0fd-695f-4608-b956-e5bad47b67ef", + "body": { + "sourcesystem": "TestSource", + "indicators": [ + { + "type": "indicator", + "spec_version": "2.1", + "id": "indicator--ad1bf017-00b9-42cb-b639-aa5a7a77b584", + "created": "2010-03-26T18:29:07.778Z", + "modified": "2011-02-26T18:29:07.778Z", + "created_by_ref": "identity--74f78359-b1ca-4ae0-9da5-6aa4874e914f", + "revoked": true, + "labels": [ + "label1", + "label2" + ], + "confidence": 55, + "lang": "en", + "externalReferences": [], + "granularMarkings": [], + "threatTypes": [ + "compromised" + ], + "name": "bot_ip: 1.1.1.1", + "description": "indicator_description", + "indicator_types": [ + "indicator_type1", + "indicator_type2" + ], + "pattern": "[ipv4-addr:value = '0.0.0.0']", + "pattern_type": "stix", + "pattern_version": "2.1", + "valid_from": "2015-02-26T18:29:07.778Z", + "valid_until": "2016-02-26T18:29:07.778Z", + "kill_chain_phases": [ + { + "kill_chain_name": "kill_chain_name", + "phase_name": "phase_name" + } + ] + }, + { + "type": "indicator", + "spec_version": "2.1", + "created": "2010-02-26T18:29:07.778Z", + "modified": "2011-02-26T18:29:07.778Z", + "name": "Test", + "pattern": "[ipv4-addr:value = '0.0.0.0']", + "pattern_type": "stix", + "valid_from": "2015-02-26T18:29:07.778Z", + "confidence": 100 + } + ] + } + }, + "responses": { + "200": { + "body": { + "errors": [ + { + "recordIndex": 1, + "validationErrorMessages": [ + "Error for Property=id: Required property is missing. Actual value: NULL." + ] + } + ] + } + } + } +} diff --git a/specification/securityinsights/data-plane/readme.md b/specification/securityinsights/data-plane/readme.md new file mode 100644 index 000000000000..b7da8b271c0e --- /dev/null +++ b/specification/securityinsights/data-plane/readme.md @@ -0,0 +1,59 @@ +# Security Insights + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for SecurityInsights. + +--- + +## Getting Started + +To build the SDK for SecurityInsights, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Tag: package-2022-12 + +These settings apply only when `--tag=package-2022-12` is specified on the command line. + +```yaml $(tag) == 'package-2022-12' +input-file: + - Microsoft.SecurityInsights/preview/2022-12-01-preview/ThreatIntelligence.json +``` + +### Supressions + +```yaml +directive: + - suppress: R3023 + where: + - $..paths["/workspaces/{workspaceId}/threat-intelligence/indicators:upload"] + from: ThreatIntelligence.json + reason: This is an ARM API requirement to list all the available operations, but this is a data-plane API. + + - suppress: R4010 + where: + - $..paths["/workspaces/{workspaceId}/threat-intelligence/indicators:upload"] + from: ThreatIntelligence.json + reason: This is an ARM API requirement to have a default error response, but it is irrelevant to this data-plane API. + + - suppress: R4041 + where: + - $..paths["/workspaces/{workspaceId}/threat-intelligence/indicators:upload"] + from: ThreatIntelligence.json + reason: This API does not have array identifiers (data-plane). + + - suppress: PathForResourceAction + where: + - $..paths["/workspaces/{workspaceId}/threat-intelligence/indicators:upload"] + from: ThreatIntelligence.json + reason: This is an ARM API naming requirement and is not relevant to a data-plane API. +``` From 5948af5ea0ed792027dc9fbc9e250c75f0189fc6 Mon Sep 17 00:00:00 2001 From: gulopesd <73562152+gulopesd@users.noreply.github.com> Date: Mon, 8 May 2023 13:56:17 -0700 Subject: [PATCH 45/79] [Hub Generated] Review request for Microsoft.Insights to add version preview/2023-05-01-preview (#23789) * Adds base for updating Microsoft.Insights from version preview/2023-03-01-preview to version 2023-05-01-preview * Updates readme * Updates API version in new specs and examples * Update new api version * Required properties * Prettier fix * Add security requirements section --- .../examples/MetricBatchExample.json | 543 +++++++++++++++++ .../2023-05-01-preview/metricBatch.json | 560 ++++++++++++++++++ specification/monitor/data-plane/readme.md | 13 +- 3 files changed, 1114 insertions(+), 2 deletions(-) create mode 100644 specification/monitor/data-plane/Microsoft.Insights/preview/2023-05-01-preview/examples/MetricBatchExample.json create mode 100644 specification/monitor/data-plane/Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json diff --git a/specification/monitor/data-plane/Microsoft.Insights/preview/2023-05-01-preview/examples/MetricBatchExample.json b/specification/monitor/data-plane/Microsoft.Insights/preview/2023-05-01-preview/examples/MetricBatchExample.json new file mode 100644 index 000000000000..ccdb2c2ffdc4 --- /dev/null +++ b/specification/monitor/data-plane/Microsoft.Insights/preview/2023-05-01-preview/examples/MetricBatchExample.json @@ -0,0 +1,543 @@ +{ + "parameters": { + "baseUrl": "https://eastus.metrics.monitor.azure.com", + "subscriptionId": "123456728-abcd-1234-abcd-123456789abc", + "starttime": "2023-02-01T20:00:00.123Z", + "endtime": "2023-02-01T23:00:00.345Z", + "interval": "PT15M", + "metricnamespace": "Microsoft.Storage/storageAccounts", + "metricnames": "Ingress,Egress", + "aggregation": "average,minimum,maximum", + "top": 10, + "orderby": "average desc", + "filter": "ApiName eq 'GetBlob' or ApiName eq 'GetBlobServiceProperties' and Authentication eq '*'", + "api-version": "2023-05-01-preview", + "resourceIds": { + "resourceids": [ + "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1", + "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2" + ] + } + }, + "responses": { + "200": { + "body": { + "values": [ + { + "starttime": "2023-02-01T20:00:00.123Z", + "endtime": "2023-02-01T23:00:00.345Z", + "interval": "PT15M", + "value": [ + { + "id": "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1/providers/Microsoft.Insights/metrics/Ingress", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "Ingress", + "localizedValue": "Ingress" + }, + "displayDescription": "The amount of ingress data, in bytes. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.", + "unit": "Bytes", + "timeseries": [ + { + "metadatavalues": [ + { + "name": { + "value": "apiname", + "localizedValue": "apiname" + }, + "value": "GetBlob" + }, + { + "name": { + "value": "authentication", + "localizedValue": "authentication" + }, + "value": "SAS" + } + ], + "data": [ + { + "timeStamp": "2023-02-01T20:00:00Z", + "average": 437, + "minimum": 437, + "maximum": 437 + }, + { + "timeStamp": "2023-02-01T20:15:00Z", + "average": 438.0735294117647, + "minimum": 437, + "maximum": 583 + }, + { + "timeStamp": "2023-02-01T20:30:00Z", + "average": 437, + "minimum": 437, + "maximum": 437 + }, + { + "timeStamp": "2023-02-01T20:45:00Z", + "average": 437.54477611940297, + "minimum": 437, + "maximum": 583 + }, + { + "timeStamp": "2023-02-01T21:00:00Z", + "average": 437, + "minimum": 437, + "maximum": 437 + }, + { + "timeStamp": "2023-02-01T21:15:00Z", + "average": 438.0735294117647, + "minimum": 437, + "maximum": 583 + }, + { + "timeStamp": "2023-02-01T21:30:00Z", + "average": 437, + "minimum": 437, + "maximum": 437 + }, + { + "timeStamp": "2023-02-01T21:45:00Z", + "average": 437.54477611940297, + "minimum": 437, + "maximum": 583 + }, + { + "timeStamp": "2023-02-01T22:00:00Z", + "average": 437, + "minimum": 437, + "maximum": 437 + }, + { + "timeStamp": "2023-02-01T22:15:00Z", + "average": 438.0735294117647, + "minimum": 437, + "maximum": 583 + }, + { + "timeStamp": "2023-02-01T22:30:00Z", + "average": 437, + "minimum": 437, + "maximum": 437 + }, + { + "timeStamp": "2023-02-01T22:45:00Z", + "average": 437.542750929368, + "minimum": 437, + "maximum": 583 + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "apiname", + "localizedValue": "apiname" + }, + "value": "GetBlobServiceProperties" + }, + { + "name": { + "value": "authentication", + "localizedValue": "authentication" + }, + "value": "AccountKey" + } + ], + "data": [ + { + "timeStamp": "2023-02-01T20:00:00Z" + }, + { + "timeStamp": "2023-02-01T20:15:00Z" + }, + { + "timeStamp": "2023-02-01T20:30:00Z" + }, + { + "timeStamp": "2023-02-01T20:45:00Z" + }, + { + "timeStamp": "2023-02-01T21:00:00Z" + }, + { + "timeStamp": "2023-02-01T21:15:00Z" + }, + { + "timeStamp": "2023-02-01T21:30:00Z" + }, + { + "timeStamp": "2023-02-01T21:45:00Z" + }, + { + "timeStamp": "2023-02-01T22:00:00Z", + "average": 342, + "minimum": 342, + "maximum": 342 + }, + { + "timeStamp": "2023-02-01T22:15:00Z" + }, + { + "timeStamp": "2023-02-01T22:30:00Z" + }, + { + "timeStamp": "2023-02-01T22:45:00Z" + } + ] + } + ], + "errorCode": "Success" + }, + { + "id": "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1/providers/Microsoft.Insights/metrics/Egress", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "Egress", + "localizedValue": "Egress" + }, + "displayDescription": "The amount of egress data. This number includes egress to external client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.", + "unit": "Bytes", + "timeseries": [ + { + "metadatavalues": [ + { + "name": { + "value": "apiname", + "localizedValue": "apiname" + }, + "value": "GetBlobServiceProperties" + }, + { + "name": { + "value": "authentication", + "localizedValue": "authentication" + }, + "value": "AccountKey" + } + ], + "data": [ + { + "timeStamp": "2023-02-01T20:00:00Z" + }, + { + "timeStamp": "2023-02-01T20:15:00Z" + }, + { + "timeStamp": "2023-02-01T20:30:00Z" + }, + { + "timeStamp": "2023-02-01T20:45:00Z" + }, + { + "timeStamp": "2023-02-01T21:00:00Z" + }, + { + "timeStamp": "2023-02-01T21:15:00Z" + }, + { + "timeStamp": "2023-02-01T21:30:00Z" + }, + { + "timeStamp": "2023-02-01T21:45:00Z" + }, + { + "timeStamp": "2023-02-01T22:00:00Z", + "average": 796, + "minimum": 796, + "maximum": 796 + }, + { + "timeStamp": "2023-02-01T22:15:00Z" + }, + { + "timeStamp": "2023-02-01T22:30:00Z" + }, + { + "timeStamp": "2023-02-01T22:45:00Z" + } + ] + }, + { + "metadatavalues": [ + { + "name": { + "value": "apiname", + "localizedValue": "apiname" + }, + "value": "GetBlob" + }, + { + "name": { + "value": "authentication", + "localizedValue": "authentication" + }, + "value": "SAS" + } + ], + "data": [ + { + "timeStamp": "2023-02-01T20:00:00Z", + "average": 361, + "minimum": 361, + "maximum": 361 + }, + { + "timeStamp": "2023-02-01T20:15:00Z", + "average": 365.83088235294116, + "minimum": 361, + "maximum": 1018 + }, + { + "timeStamp": "2023-02-01T20:30:00Z", + "average": 361, + "minimum": 361, + "maximum": 361 + }, + { + "timeStamp": "2023-02-01T20:45:00Z", + "average": 363.4514925373134, + "minimum": 361, + "maximum": 1018 + }, + { + "timeStamp": "2023-02-01T21:00:00Z", + "average": 361, + "minimum": 361, + "maximum": 361 + }, + { + "timeStamp": "2023-02-01T21:15:00Z", + "average": 365.83088235294116, + "minimum": 361, + "maximum": 1018 + }, + { + "timeStamp": "2023-02-01T21:30:00Z", + "average": 361, + "minimum": 361, + "maximum": 361 + }, + { + "timeStamp": "2023-02-01T21:45:00Z", + "average": 363.4514925373134, + "minimum": 361, + "maximum": 1018 + }, + { + "timeStamp": "2023-02-01T22:00:00Z", + "average": 361, + "minimum": 361, + "maximum": 361 + }, + { + "timeStamp": "2023-02-01T22:15:00Z", + "average": 365.83088235294116, + "minimum": 361, + "maximum": 1018 + }, + { + "timeStamp": "2023-02-01T22:30:00Z", + "average": 361, + "minimum": 361, + "maximum": 361 + }, + { + "timeStamp": "2023-02-01T22:45:00Z", + "average": 363.4423791821561, + "minimum": 361, + "maximum": 1018 + } + ] + } + ], + "errorCode": "Success" + } + ], + "namespace": "microsoft.storage/storageaccounts", + "resourceregion": "eastus", + "resourceid": "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1" + }, + { + "starttime": "2023-02-01T20:00:00.123Z", + "endtime": "2023-02-01T23:00:00.345Z", + "interval": "PT15M", + "value": [ + { + "id": "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2/providers/Microsoft.Insights/metrics/Ingress", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "Ingress", + "localizedValue": "Ingress" + }, + "displayDescription": "The amount of ingress data, in bytes. This number includes ingress from an external client into Azure Storage as well as ingress within Azure.", + "unit": "Bytes", + "timeseries": [ + { + "metadatavalues": [ + { + "name": { + "value": "apiname", + "localizedValue": "apiname" + }, + "value": "GetBlobServiceProperties" + }, + { + "name": { + "value": "authentication", + "localizedValue": "authentication" + }, + "value": "AccountKey" + } + ], + "data": [ + { + "timeStamp": "2023-02-01T20:00:00Z" + }, + { + "timeStamp": "2023-02-01T20:15:00Z" + }, + { + "timeStamp": "2023-02-01T20:30:00Z" + }, + { + "timeStamp": "2023-02-01T20:45:00Z" + }, + { + "timeStamp": "2023-02-01T21:00:00Z" + }, + { + "timeStamp": "2023-02-01T21:15:00Z" + }, + { + "timeStamp": "2023-02-01T21:30:00Z" + }, + { + "timeStamp": "2023-02-01T21:45:00Z" + }, + { + "timeStamp": "2023-02-01T22:00:00Z", + "average": 330, + "minimum": 330, + "maximum": 330 + }, + { + "timeStamp": "2023-02-01T22:15:00Z" + }, + { + "timeStamp": "2023-02-01T22:30:00Z" + }, + { + "timeStamp": "2023-02-01T22:45:00Z" + } + ] + } + ], + "errorCode": "Success" + }, + { + "id": "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2/providers/Microsoft.Insights/metrics/Egress", + "type": "Microsoft.Insights/metrics", + "name": { + "value": "Egress", + "localizedValue": "Egress" + }, + "displayDescription": "The amount of egress data. This number includes egress to external client from Azure Storage as well as egress within Azure. As a result, this number does not reflect billable egress.", + "unit": "Bytes", + "timeseries": [ + { + "metadatavalues": [ + { + "name": { + "value": "apiname", + "localizedValue": "apiname" + }, + "value": "GetBlobServiceProperties" + }, + { + "name": { + "value": "authentication", + "localizedValue": "authentication" + }, + "value": "AccountKey" + } + ], + "data": [ + { + "timeStamp": "2023-02-01T20:00:00Z" + }, + { + "timeStamp": "2023-02-01T20:15:00Z" + }, + { + "timeStamp": "2023-02-01T20:30:00Z" + }, + { + "timeStamp": "2023-02-01T20:45:00Z" + }, + { + "timeStamp": "2023-02-01T21:00:00Z" + }, + { + "timeStamp": "2023-02-01T21:15:00Z" + }, + { + "timeStamp": "2023-02-01T21:30:00Z" + }, + { + "timeStamp": "2023-02-01T21:45:00Z" + }, + { + "timeStamp": "2023-02-01T22:00:00Z", + "average": 880, + "minimum": 880, + "maximum": 880 + }, + { + "timeStamp": "2023-02-01T22:15:00Z" + }, + { + "timeStamp": "2023-02-01T22:30:00Z" + }, + { + "timeStamp": "2023-02-01T22:45:00Z" + } + ] + } + ], + "errorCode": "Success" + } + ], + "namespace": "microsoft.storage/storageaccounts", + "resourceregion": "eastus", + "resourceid": "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2" + } + ] + } + }, + "default": { + "headers": { + "x-ms-error-code": "BadRequest" + }, + "body": { + "error": { + "additionalInfo": [ + { + "type": "string", + "info": "TraceId={00000000-0000-0000-0000-000000000000}" + }, + { + "type": "string", + "info": "ExceptionType=Microsoft.Online.Metrics.MetricsMP.Utilities.RPRequestFormatException" + } + ], + "code": "BadRequest", + "message": "Query endTime: 06/06/2021 00:00:00 is out of the Max metrics retention period: 93.00:00:00, traceId: {00000000-0000-0000-0000-000000000000}" + } + } + } + } +} diff --git a/specification/monitor/data-plane/Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json b/specification/monitor/data-plane/Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json new file mode 100644 index 000000000000..0702469e56b5 --- /dev/null +++ b/specification/monitor/data-plane/Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json @@ -0,0 +1,560 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Monitor Metric Batch", + "version": "2023-05-01-preview" + }, + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "tokenUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/token", + "flow": "application", + "description": "Azure Active Directory OAuth2 Authentication", + "scopes": { + "https://metrics.monitor.azure.com/.default": "https://metrics.monitor.azure.com/.default" + } + } + }, + "security": [ + { + "AADToken": [ + "https://metrics.monitor.azure.com/.default" + ] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{baseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "baseUrl", + "description": "The regional endpoint to use, for example https://eastus.metrics.monitor.azure.com. The region should match the region of the requested resources. For global resources, the region should be 'global'.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/metrics:getBatch": { + "post": { + "tags": [ + "Metrics" + ], + "operationId": "Metrics_Batch", + "description": "Lists the metric values for multiple resources.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/StartTimeParameter" + }, + { + "$ref": "#/parameters/EndTimeParameter" + }, + { + "$ref": "#/parameters/IntervalParameter" + }, + { + "$ref": "#/parameters/MetricNamespaceParameter" + }, + { + "$ref": "#/parameters/MetricNamesParameter" + }, + { + "$ref": "#/parameters/AggregationsParameter" + }, + { + "$ref": "#/parameters/TopParameter" + }, + { + "$ref": "#/parameters/OrderByParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceIdList" + } + ], + "responses": { + "200": { + "description": "The response to a metrics query.", + "schema": { + "$ref": "#/definitions/MetricResultsResponse" + } + }, + "default": { + "description": "Describes the format of Error response.", + "headers": { + "x-ms-error-code": { + "type": "string", + "description": "Error code for specific error that occurred." + } + }, + "schema": { + "$ref": "#/definitions/AdditionalInfoErrorResponse" + } + } + }, + "x-ms-examples": { + "Query Storage Metrics": { + "$ref": "./examples/MetricBatchExample.json" + } + } + } + } + }, + "parameters": { + "ResourceIdList": { + "name": "resourceIds", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceIdList" + }, + "description": "The comma separated list of resource IDs to query metrics for." + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription identifier for the resources in this batch.", + "x-ms-parameter-location": "method" + }, + "StartTimeParameter": { + "name": "starttime", + "in": "query", + "required": false, + "type": "string", + "description": "The start time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'. If you have specified the endtime parameter, then this parameter is required.\nIf only starttime is specified, then endtime defaults to the current time.\nIf no time interval is specified, the default is 1 hour.", + "x-ms-parameter-location": "method" + }, + "EndTimeParameter": { + "name": "endtime", + "in": "query", + "required": false, + "type": "string", + "description": "The end time of the query. It is a string in the format 'yyyy-MM-ddTHH:mm:ss.fffZ'.", + "x-ms-parameter-location": "method" + }, + "IntervalParameter": { + "name": "interval", + "in": "query", + "required": false, + "type": "string", + "format": "duration", + "default": "PT1M", + "description": "The interval (i.e. timegrain) of the query.\n*Examples: PT15M, PT1H, P1D*", + "x-ms-parameter-location": "method" + }, + "MetricNamespaceParameter": { + "name": "metricnamespace", + "in": "query", + "required": true, + "type": "string", + "description": "Metric namespace that contains the requested metric names.", + "x-ms-parameter-location": "method" + }, + "MetricNamesParameter": { + "name": "metricnames", + "in": "query", + "required": true, + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "csv", + "description": "The names of the metrics (comma separated) to retrieve.", + "x-ms-parameter-location": "method" + }, + "AggregationsParameter": { + "name": "aggregation", + "in": "query", + "required": false, + "type": "string", + "description": "The list of aggregation types (comma separated) to retrieve.\n*Examples: average, minimum, maximum*", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The maximum number of records to retrieve per resource ID in the request.\nValid only if filter is specified.\nDefaults to 10.", + "x-ms-parameter-location": "method" + }, + "OrderByParameter": { + "name": "orderby", + "in": "query", + "required": false, + "type": "string", + "description": "The aggregation to use for sorting results and the direction of the sort.\nOnly one order can be specified.\n*Examples: sum asc*", + "x-ms-parameter-location": "method" + }, + "FilterParameter": { + "name": "filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter is used to reduce the set of metric data returned.
Example:
Metric contains metadata A, B and C.
- Return all time series of C where A = a1 and B = b1 or b2
**filter=A eq ‘a1’ and B eq ‘b1’ or B eq ‘b2’ and C eq ‘*’**
- Invalid variant:
**filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘*’ or B = ‘b2’**
This is invalid because the logical or operator cannot separate two different metadata names.
- Return all time series where A = a1, B = b1 and C = c1:
**filter=A eq ‘a1’ and B eq ‘b1’ and C eq ‘c1’**
- Return all time series where A = a1
**filter=A eq ‘a1’ and B eq ‘*’ and C eq ‘*’**.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + } + }, + "definitions": { + "ResourceIdList": { + "description": "The comma separated list of resource IDs to query metrics for.", + "type": "object", + "properties": { + "resourceids": { + "description": "The list of resource IDs to query metrics for.", + "type": "array", + "items": { + "type": "string", + "format": "arm-id" + } + } + }, + "example": { + "resourceids": [ + "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage1", + "/subscriptions/123456728-abcd-1234-abcd-123456789abc/resourceGroups/TestGroup/providers/Microsoft.Storage/storageAccounts/TestStorage2" + ] + } + }, + "AdditionalInfoErrorResponse": { + "description": "The response to a metrics query that results in a bad request, with optional additional information.", + "type": "object", + "properties": { + "error": { + "description": "Top level error object that contains all relevant information.", + "type": "object", + "properties": { + "additionalInfo": { + "description": "Additional information about the error", + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "description": "The type of the info property (e.g. string).", + "type": "string" + }, + "info": { + "description": "Additional information related to the error.", + "type": "string" + } + } + } + }, + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + } + }, + "required": [ + "error" + ] + }, + "MetricResultsResponse": { + "description": "The metrics result for a resource.", + "type": "object", + "properties": { + "values": { + "description": "The collection of metric data responses per resource, per metric.", + "type": "array", + "items": { + "type": "object", + "properties": { + "starttime": { + "type": "string", + "description": "The start time, in datetime format, for which the data was retrieved." + }, + "endtime": { + "type": "string", + "description": "The end time, in datetime format, for which the data was retrieved." + }, + "interval": { + "type": "string", + "format": "duration", + "description": "The interval (window size) for which the metric data was returned in. Follows the IS8601/RFC3339 duration format (e.g. 'P1D' for 1 day). This may be adjusted in the future and returned back from what was originally requested. This is not present if a metadata request was made." + }, + "namespace": { + "type": "string", + "description": "The namespace of the metrics been queried" + }, + "resourceregion": { + "type": "string", + "description": "The region of the resource been queried for metrics." + }, + "resourceid": { + "type": "string", + "description": "The resource that has been queried for metrics." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Metric" + }, + "description": "The value of the collection." + } + }, + "required": [ + "starttime", + "endtime", + "value" + ] + } + } + } + }, + "LocalizableString": { + "type": "object", + "required": [ + "value" + ], + "properties": { + "value": { + "type": "string", + "description": "The invariant value." + }, + "localizedValue": { + "type": "string", + "description": "The display name." + } + }, + "description": "The localizable string class." + }, + "MetricUnit": { + "type": "string", + "description": "The unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "CountPerSecond", + "BytesPerSecond", + "Percent", + "MilliSeconds", + "ByteSeconds", + "Unspecified", + "Cores", + "MilliCores", + "NanoCores", + "BitsPerSecond" + ], + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": false, + "values": [ + { + "value": "Count", + "description": "Unit of raw quantity." + }, + { + "value": "Bytes", + "description": "Unit of memory in bytes." + }, + { + "value": "Seconds", + "description": "Unit of time in seconds." + }, + { + "value": "CountPerSecond", + "description": "Rate unit of raw quantity per second." + }, + { + "value": "BytesPerSecond", + "description": "Rate unit of memory in bytes per second." + }, + { + "value": "Percent", + "description": "Percentage unit." + }, + { + "value": "MilliSeconds", + "description": "Unit of time in 1/1000th of a second." + }, + { + "value": "ByteSeconds", + "description": "Unit of data transfer or storage. It is the size of the data in bytes multiplied by the time it takes to transfer or store the data in seconds." + }, + { + "value": "Unspecified", + "description": "No specified unit." + }, + { + "value": "Cores", + "description": "Unit of processing power." + }, + { + "value": "MilliCores", + "description": "Unit of processing power in 1/1000th of a CPU core." + }, + { + "value": "NanoCores", + "description": "Unit of processing power in one billionth of a CPU core." + }, + { + "value": "BitsPerSecond", + "description": "Rate unit of binary digits per second." + } + ] + } + }, + "MetricValue": { + "type": "object", + "required": [ + "timeStamp" + ], + "properties": { + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "The timestamp for the metric value in ISO 8601 format." + }, + "average": { + "type": "number", + "format": "double", + "description": "The average value in the time range." + }, + "minimum": { + "type": "number", + "format": "double", + "description": "The least value in the time range." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "The greatest value in the time range." + }, + "total": { + "type": "number", + "format": "double", + "description": "The sum of all of the values in the time range." + }, + "count": { + "type": "number", + "format": "double", + "description": "The number of samples in the time range. Can be used to determine the number of values that contributed to the average value." + } + }, + "description": "Represents a metric value." + }, + "MetadataValue": { + "type": "object", + "properties": { + "name": { + "$ref": "#/definitions/LocalizableString", + "description": "The name of the metadata." + }, + "value": { + "type": "string", + "description": "The value of the metadata." + } + }, + "description": "Represents a metric metadata value." + }, + "Metric": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The metric Id." + }, + "name": { + "$ref": "#/definitions/LocalizableString", + "description": "The name and the display name of the metric, i.e. it is localizable string." + }, + "displayDescription": { + "type": "string", + "description": "Description of this metric" + }, + "type": { + "type": "string", + "description": "The resource type of the metric resource." + }, + "unit": { + "$ref": "#/definitions/MetricUnit", + "description": "The unit of the metric." + }, + "timeseries": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesElement" + }, + "description": "The time series returned when a data query is performed." + }, + "errorCode": { + "type": "string", + "description": "'Success' or the error details on query failures for this metric." + }, + "errorMessage": { + "type": "string", + "description": "Error message encountered querying this specific metric." + } + }, + "required": [ + "id", + "name", + "displayDescription", + "type", + "unit", + "timeseries" + ], + "description": "The result data of a query." + }, + "TimeSeriesElement": { + "type": "object", + "properties": { + "metadatavalues": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataValue" + }, + "description": "The metadata values returned if filter was specified in the call." + }, + "data": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricValue" + }, + "description": "An array of data points representing the metric values. This is only returned if a result type of data is specified." + } + }, + "description": "A time series result type. The discriminator value is always TimeSeries in this case." + } + } +} diff --git a/specification/monitor/data-plane/readme.md b/specification/monitor/data-plane/readme.md index dd5c5a910645..1cc58a6c9800 100644 --- a/specification/monitor/data-plane/readme.md +++ b/specification/monitor/data-plane/readme.md @@ -28,19 +28,28 @@ These are the global settings for the MonitorClient API. title: MonitorClient description: Monitor Management Client openapi-type: data-plane -tag: package-preview-2023-03 +tag: package-preview-2023-05 ``` +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - Microsoft.Insights/preview/2023-05-01-preview/metricBatch.json +``` ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-03' +``` yaml $(tag) == 'package-preview-2023-03' input-file: - Microsoft.Insights/preview/2023-03-01-preview/metricBatch.json - preview/2018-09-01-preview/metricsCreate_API.json ``` + ### Tag: package-2018-09-preview These settings apply only when `--tag=package-2018-09-preview` is specified on the command line. From a7c1c7c33ac4573a426dcecfa8de076993d6d700 Mon Sep 17 00:00:00 2001 From: Osahumen Uyi Aghasomwan <65305780+osaghaso@users.noreply.github.com> Date: Mon, 8 May 2023 17:15:43 -0700 Subject: [PATCH 46/79] Removing unwanted variable (#23865) --- .../stable/2018-01-01/AzureCommunicationServices.json | 4 ---- 1 file changed, 4 deletions(-) diff --git a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json index 4537bd6f6852..75514ddd4d09 100644 --- a/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json +++ b/specification/eventgrid/data-plane/Microsoft.Communication/stable/2018-01-01/AzureCommunicationServices.json @@ -901,10 +901,6 @@ "description": "Custom Context of Incoming Call", "type": "object", "properties": { - "customHeaders": { - "type": "string", - "description": "Custom Headers for incoming call" - }, "sipHeaders": { "type": "object", "description": "Sip Headers for incoming call", From 4a7af0df86022e5e6cc6e8f40ca1981c4557a4bc Mon Sep 17 00:00:00 2001 From: Anjikya Tiwari <116218102+ajtiwari07@users.noreply.github.com> Date: Mon, 8 May 2023 19:11:42 -0700 Subject: [PATCH 47/79] Update 2023-05-01-preview version with changes from 2023-04-01 version. (#23835) --- .../examples/RedisCacheExport.json | 3 ++- .../examples/RedisCacheImport.json | 3 ++- .../preview/2023-05-01-preview/redis.json | 12 ++++++++++++ 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheExport.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheExport.json index aa8b96f814e1..325a7b337102 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheExport.json +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheExport.json @@ -7,7 +7,8 @@ "parameters": { "format": "RDB", "prefix": "datadump1", - "container": "https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters" + "container": "https://contosostorage.blob.core.window.net/urltoBlobContainer?sasKeyParameters", + "storage-subscription-id": "storageSubId" } }, "responses": { diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheImport.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheImport.json index 474dfbfba9db..93a315ba8374 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheImport.json +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/examples/RedisCacheImport.json @@ -8,7 +8,8 @@ "format": "RDB", "files": [ "http://fileuris.contoso.com/pathtofile1" - ] + ], + "storage-subscription-id": "storageSubId" } }, "responses": { diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/redis.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/redis.json index 78694fead0f5..18fdcd99e8a0 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2023-05-01-preview/redis.json @@ -2234,6 +2234,10 @@ "type": "string", "description": "Specifies whether the authentication is disabled. Setting this property is highly discouraged from security point of view." }, + "storage-subscription-id": { + "type": "string", + "description": "SubscriptionId of the storage account for persistence (aof/rdb) using ManagedIdentity." + }, "aad-enabled": { "type": "string", "description": "Specifies whether AAD based authentication has been enabled or disabled for the cache" @@ -2720,6 +2724,10 @@ "preferred-data-archive-auth-method": { "type": "string", "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS" + }, + "storage-subscription-id": { + "type": "string", + "description": "Subscription id of the storage container for data to be exported using ManagedIdentity." } }, "required": [ @@ -2744,6 +2752,10 @@ "preferred-data-archive-auth-method": { "type": "string", "description": "Preferred auth method to communicate to storage account used for data archive, specify SAS or ManagedIdentity, default value is SAS" + }, + "storage-subscription-id": { + "type": "string", + "description": "Subscription id of the storage container containing files to import using Managed Identity." } }, "required": [ From d5c8648e01a2a2a743c2649c9522d21f5db952ce Mon Sep 17 00:00:00 2001 From: zhenbiao wei <424401670@qq.com> Date: Tue, 9 May 2023 10:27:28 +0800 Subject: [PATCH 48/79] Update readme.python.md (#23850) --- .../network/resource-manager/readme.python.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/network/resource-manager/readme.python.md b/specification/network/resource-manager/readme.python.md index 22f0c1aabe5e..1b4a794673e6 100644 --- a/specification/network/resource-manager/readme.python.md +++ b/specification/network/resource-manager/readme.python.md @@ -18,10 +18,10 @@ Generate all API versions currently shipped for this package ```yaml $(python) multiapi: true -default-api-version: "2022-09-01" +default-api-version: "2022-11-01" clear-output-folder: true batch: - - tag: package-2022-09 + - tag: package-2022-11 - tag: package-2021-02 - tag: package-2021-02-preview-only - tag: package-2020-11 @@ -53,14 +53,14 @@ output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/netwo perform-load: false ``` -### Tag: package-2022-09 and python +### Tag: package-2022-11 and python -These settings apply only when `--tag=package-2022-09 --python` is specified on the command line. +These settings apply only when `--tag=package-2022-11 --python` is specified on the command line. Please also specify `--python-sdks-folder=`. -``` yaml $(tag) == 'package-2022-09' -namespace: azure.mgmt.network.v2022_09_01 -output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2022_09_01 +``` yaml $(tag) == 'package-2022-11' +namespace: azure.mgmt.network.v2022_11_01 +output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2022_11_01 ``` ### Tag: package-2021-02-preview-only and python From 17c41d0c4a96294bf563b009c9c72093963b529f Mon Sep 17 00:00:00 2001 From: mengaims <50131889+mengaims@users.noreply.github.com> Date: Tue, 9 May 2023 12:33:54 +0800 Subject: [PATCH 49/79] [Hub Generated] Publish private branch 'mengai/cm-vnext-image' (#23840) * add cm vnext contract * Update field and description * Add base path * Remove useless categories * remove PII and Profanity * Update swagger * Add new version for public preview * update image lists * Fix text analyze api * update * Create new folder for project carnegie * move 09-30 preview to new folder * rename json files * update text list management APIs * rename version and remove useless field * update list related contract * Fix some details * Fix base path * fix path wording * Changed image contract related fix * Change strategy from enum to boolean * Remove confidence score * Fix list item patch request * Change HateSpeech to Hate * Remove TextDetectStrategy definition * remove item text ambiguity * add offset and length to list match result * remove format for image;change Text-Location to Location * edit description * change language example * Add public preview contract 2023-04-30-preview * Add action contract * Initial version of cadl files and compiled swagger * add readme.md * Remove useless apis and examples * Fix werid models * replace list management with resource operations * Fix some details * Fix some types and docs * change url type * Add action configurations and output * Remove action related fields * Change language to languages and place it into body * List management API update: 1. use only name or id 2. generate itemId by service 3. add batch actions to insert/remove items * Add client-driven paging * Align the lowercase of blocklist * Add the package-lock file * Specify Azure Core version * Use Azure.Core.RpcOperation for analyze apis * Change image content from string to byte * Update client-driven paging for list items * Rename from ProjectCarnegie to ContentSafety * remove language code input * Rename and doc change for swagger * Changed some variable names and method names * Add description for text length * Change description for text length * Add uuid description for block item id * Fix doc grammer * change url to blobUrl * Add categories description to doc * Fix some typos * Fix the package version and change image analyze function name * hotfix: change addBlockItems response and add some doc wording fix. * Update some decorates * Format files * Fix the json file reference in readme * Add examples * Remove sensitive word * Fix SpellCheck and remove go * Add contentsafety to custom workds * Add dotnet sdk to readme * Add pattern decorate and change dotnet sdk setting * remove convnient decorate --- custom-words.txt | 1 + .../2023-04-30-preview/AddBlockItems.json | 29 + .../2023-04-30-preview/AnalyzeImage.json | 34 + .../2023-04-30-preview/AnalyzeText.json | 33 + .../CreateOrUpdateTextBlocklist.json | 25 + .../DeleteTextBlocklist.json | 11 + .../2023-04-30-preview/GetTextBlocklist.json | 16 + .../GetTextBlocklistItem.json | 18 + .../ListTextBlocklistItems.json | 21 + .../ListTextBlocklists.json | 19 + .../2023-04-30-preview/RemoveBlockItems.json | 16 + .../cognitiveservices/ContentSafety/main.tsp | 34 + .../ContentSafety/models.tsp | 193 +++ .../ContentSafety/routes.tsp | 89 ++ .../ContentSafety/tspconfig.yaml | 38 + .../2023-04-30-preview/contentsafety.json | 1074 +++++++++++++++++ .../examples/AddBlockItems.json | 29 + .../examples/AnalyzeImage.json | 34 + .../examples/AnalyzeText.json | 33 + .../examples/CreateOrUpdateTextBlocklist.json | 25 + .../examples/DeleteTextBlocklist.json | 11 + .../examples/GetTextBlocklist.json | 16 + .../examples/GetTextBlocklistItem.json | 18 + .../examples/ListTextBlocklistItems.json | 21 + .../examples/ListTextBlocklists.json | 19 + .../examples/RemoveBlockItems.json | 16 + .../data-plane/ContentSafety/readme.md | 78 ++ 27 files changed, 1951 insertions(+) create mode 100644 specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AddBlockItems.json create mode 100644 specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AnalyzeImage.json create mode 100644 specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AnalyzeText.json create mode 100644 specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/CreateOrUpdateTextBlocklist.json create mode 100644 specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/DeleteTextBlocklist.json create mode 100644 specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/GetTextBlocklist.json create mode 100644 specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/GetTextBlocklistItem.json create mode 100644 specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/ListTextBlocklistItems.json create mode 100644 specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/ListTextBlocklists.json create mode 100644 specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/RemoveBlockItems.json create mode 100644 specification/cognitiveservices/ContentSafety/main.tsp create mode 100644 specification/cognitiveservices/ContentSafety/models.tsp create mode 100644 specification/cognitiveservices/ContentSafety/routes.tsp create mode 100644 specification/cognitiveservices/ContentSafety/tspconfig.yaml create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AddBlockItems.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AnalyzeImage.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AnalyzeText.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/CreateOrUpdateTextBlocklist.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/DeleteTextBlocklist.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/GetTextBlocklist.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/GetTextBlocklistItem.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/ListTextBlocklistItems.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/ListTextBlocklists.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/RemoveBlockItems.json create mode 100644 specification/cognitiveservices/data-plane/ContentSafety/readme.md diff --git a/custom-words.txt b/custom-words.txt index 31b49908018c..9bb7e88f4e12 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -2810,3 +2810,4 @@ Hnsw Piqd Reranked Reranking +contentsafety \ No newline at end of file diff --git a/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AddBlockItems.json b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AddBlockItems.json new file mode 100644 index 000000000000..3670641ca73b --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AddBlockItems.json @@ -0,0 +1,29 @@ +{ + "title": "Add BlockItems To Text Blocklist", + "operationId": "TextBlocklists_AddBlockItems", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist", + "body": { + "blockItems": [ + { + "description": "Hate word", + "text": "hate" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "blockItemId": "9511969e-f1e3-4604-9127-05ee16c509ec", + "description": "Hate word", + "text": "hate" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AnalyzeImage.json b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AnalyzeImage.json new file mode 100644 index 000000000000..7224de71454c --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AnalyzeImage.json @@ -0,0 +1,34 @@ +{ + "title": "Analyze Image", + "operationId": "ImageOperations_AnalyzeImage", + "parameters": { + "api-version": "2023-04-30-preview", + "body": { + "image": { + "content": "Y29udGVudDE=" + } + } + }, + "responses": { + "200": { + "body": { + "hateResult": { + "category": "Hate", + "severity": 0 + }, + "selfHarmResult": { + "category": "Hate", + "severity": 0 + }, + "sexualResult": { + "category": "Hate", + "severity": 0 + }, + "violenceResult": { + "category": "Hate", + "severity": 2 + } + } + } + } +} diff --git a/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AnalyzeText.json b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AnalyzeText.json new file mode 100644 index 000000000000..5d5bf56e9fcf --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/AnalyzeText.json @@ -0,0 +1,33 @@ +{ + "title": "Analyze Text", + "operationId": "TextOperations_AnalyzeText", + "parameters": { + "api-version": "2023-04-30-preview", + "body": { + "text": "This is text example" + } + }, + "responses": { + "200": { + "body": { + "blocklistsMatchResults": [], + "hateResult": { + "category": "Hate", + "severity": 0 + }, + "selfHarmResult": { + "category": "SelfHarm", + "severity": 0 + }, + "sexualResult": { + "category": "Sexual", + "severity": 0 + }, + "violenceResult": { + "category": "Violence", + "severity": 0 + } + } + } + } +} diff --git a/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/CreateOrUpdateTextBlocklist.json b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/CreateOrUpdateTextBlocklist.json new file mode 100644 index 000000000000..c20bc792687d --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/CreateOrUpdateTextBlocklist.json @@ -0,0 +1,25 @@ +{ + "title": "Create Or Update Text Blocklist", + "operationId": "TextBlocklists_CreateOrUpdateTextBlocklist", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist", + "resource": { + "description": "Test Blocklist" + } + }, + "responses": { + "200": { + "body": { + "blocklistName": "TestBlocklist", + "description": "Test Blocklist" + } + }, + "201": { + "body": { + "blocklistName": "TestBlocklist", + "description": "Test Blocklist" + } + } + } +} diff --git a/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/DeleteTextBlocklist.json b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/DeleteTextBlocklist.json new file mode 100644 index 000000000000..c671893d679a --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/DeleteTextBlocklist.json @@ -0,0 +1,11 @@ +{ + "title": "Delete Text Blocklist By blocklistName", + "operationId": "TextBlocklists_DeleteTextBlocklist", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/GetTextBlocklist.json b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/GetTextBlocklist.json new file mode 100644 index 000000000000..4969426906de --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/GetTextBlocklist.json @@ -0,0 +1,16 @@ +{ + "title": "Get Text Blocklist By blocklistName", + "operationId": "TextBlocklists_GetTextBlocklist", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist" + }, + "responses": { + "200": { + "body": { + "blocklistName": "TestBlocklist", + "description": "Test Blocklist" + } + } + } +} diff --git a/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/GetTextBlocklistItem.json b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/GetTextBlocklistItem.json new file mode 100644 index 000000000000..94da2bfbdaa9 --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/GetTextBlocklistItem.json @@ -0,0 +1,18 @@ +{ + "title": "Get BlockItem By blocklistName And blockItemId", + "operationId": "TextBlocklists_GetTextBlocklistItem", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist", + "blockItemId": "9511969e-f1e3-4604-9127-05ee16c509ec" + }, + "responses": { + "200": { + "body": { + "blockItemId": "9511969e-f1e3-4604-9127-05ee16c509ec", + "description": "Hate word", + "text": "hate" + } + } + } +} diff --git a/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/ListTextBlocklistItems.json b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/ListTextBlocklistItems.json new file mode 100644 index 000000000000..6c7955b98842 --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/ListTextBlocklistItems.json @@ -0,0 +1,21 @@ +{ + "title": "Get All BlockItems By blocklistName", + "operationId": "TextBlocklists_ListTextBlocklistItems", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "blockItemId": "9511969e-f1e3-4604-9127-05ee16c509ec", + "description": "Hate word", + "text": "hate" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/ListTextBlocklists.json b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/ListTextBlocklists.json new file mode 100644 index 000000000000..ea72669941d3 --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/ListTextBlocklists.json @@ -0,0 +1,19 @@ +{ + "title": "Get All Text Blocklists", + "operationId": "TextBlocklists_ListTextBlocklists", + "parameters": { + "api-version": "2023-04-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "blocklistName": "TestBlocklist", + "description": "Test Blocklist" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/RemoveBlockItems.json b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/RemoveBlockItems.json new file mode 100644 index 000000000000..fc7ea3a3fea3 --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/examples/2023-04-30-preview/RemoveBlockItems.json @@ -0,0 +1,16 @@ +{ + "title": "Remove BlockItems From Text Blocklist", + "operationId": "TextBlocklists_RemoveBlockItems", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist", + "body": { + "blockItemIds": [ + "9511969e-f1e3-4604-9127-05ee16c509ec" + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/ContentSafety/main.tsp b/specification/cognitiveservices/ContentSafety/main.tsp new file mode 100644 index 000000000000..6eaad6a9f406 --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/main.tsp @@ -0,0 +1,34 @@ +import "@typespec/http"; +import "@typespec/rest"; +import "@typespec/versioning"; +import "@azure-tools/typespec-azure-core"; +import "./routes.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; + +@service({ + title: "ContentSafety Service", +}) +@versioned(ContentSafety.Versions) +@useAuth(ApiKeyAuth) +@server( + "{endpoint}/contentsafety", + "Analyze harmful content", + { + @doc(""" +Supported Cognitive Services endpoints (protocol and hostname, for example: +https://.cognitiveservices.azure.com). +""") + endpoint: string, + } +) +@doc("Analyze harmful content") +namespace ContentSafety; + +enum Versions { + @useDependency(Azure.Core.Versions.v1_0_Preview_2) + v2023_04_30_Preview: "2023-04-30-preview", +} diff --git a/specification/cognitiveservices/ContentSafety/models.tsp b/specification/cognitiveservices/ContentSafety/models.tsp new file mode 100644 index 000000000000..9cd1cd8011ef --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/models.tsp @@ -0,0 +1,193 @@ +import "@typespec/http"; +import "@typespec/rest"; + +using TypeSpec.Http; +using TypeSpec.Rest; + +namespace ContentSafety; + +@doc("Text analyze category") +enum TextCategory { + Hate, + SelfHarm, + Sexual, + Violence, +} + +@doc("Image analyze category") +enum ImageCategory { + Hate, + SelfHarm, + Sexual, + Violence, +} + +@doc("The analysis request of the text.") +model AnalyzeTextOptions { + @doc("The text needs to be scanned. We support at most 1000 characters (unicode code points) in text of one request.") + @maxLength(1000) + text: string; + + @doc("The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned.") + categories?: TextCategory[]; + + @doc("The names of blocklists.") + blocklistNames?: string[]; + + @doc("When set to true, further analyses of harmful content will not be performed in cases where blocklists are hit. When set to false, all analyses of harmful content will be performed, whether or not blocklists are hit.") + breakByBlocklists?: boolean; +} + +@doc("The analysis response of the text") +model AnalyzeTextResult { + @doc("The details of blocklist match.") + blocklistsMatchResults?: TextBlocklistMatchResult[]; + + @doc("Analysis result for Hate category.") + hateResult?: TextAnalyzeSeverityResult; + + @doc("Analysis result for SelfHarm category.") + selfHarmResult?: TextAnalyzeSeverityResult; + + @doc("Analysis result for Sexual category.") + sexualResult?: TextAnalyzeSeverityResult; + + @doc("Analysis result for Violence category.") + violenceResult?: TextAnalyzeSeverityResult; +} + +@doc("The result of blocklist match.") +model TextBlocklistMatchResult { + @doc("The name of matched blocklist.") + @maxLength(64) + blocklistName: string; + + @doc("The id of matched item.") + @maxLength(64) + blockItemId: string; + + @doc("The content of matched item.") + @maxLength(128) + blockItemText: string; + + @doc("The character offset of matched text in original input.") + offset: int32; + + @doc("The length of matched text in original input.") + length: int32; +} + +@doc("Text analysis result.") +model TextAnalyzeSeverityResult { + @doc("The text category.") + category: TextCategory; + + @doc("The higher the severity of input content, the larger this value is. The values could be: 0,2,4,6.") + severity: int32; +} + +@doc("The analysis request of the image.") +model AnalyzeImageOptions { + @doc("The image needs to be analyzed.") + image: ImageData; + + @doc("The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned.") + categories?: ImageCategory[]; +} + +@doc("The content or blob url of image, could be base64 encoding bytes or blob url. If both are given, the request will be refused. The maximum size of image is 2048 pixels * 2048 pixels, no larger than 4MB at the same time. The minimum size of image is 50 pixels * 50 pixels.") +@projectedName("csharp", "ContentSafetyImageData") +model ImageData { + @doc("Base64 encoding of image.") + content?: bytes; + + @doc("The blob url of image.") + blobUrl?: url; +} + +@doc("The analysis response of the image.") +model AnalyzeImageResult { + @doc("Analysis result for Hate category.") + hateResult?: ImageAnalyzeSeverityResult; + + @doc("Analysis result for SelfHarm category.") + selfHarmResult?: ImageAnalyzeSeverityResult; + + @doc("Analysis result for Sexual category.") + sexualResult?: ImageAnalyzeSeverityResult; + + @doc("Analysis result for Violence category.") + violenceResult?: ImageAnalyzeSeverityResult; +} + +@doc("Image analysis result.") +model ImageAnalyzeSeverityResult { + @doc("The image category.") + category: ImageCategory; + + @doc("The higher the severity of input content, the larger this value, currently its value could be: 0,2,4,6.") + severity: int32; +} + +@doc("Text Blocklist.") +@resource("text/blocklists") +model TextBlocklist { + @doc("Text blocklist name.") + @pattern("^[0-9A-Za-z._~-]+$") + @key("blocklistName") + @visibility("read", "create", "query") + @maxLength(64) + blocklistName: string; + + @doc("Text blocklist description.") + @maxLength(1024) + description?: string; +} + +@doc("Item in TextBlocklist.") +@resource("blockItems") +@parentResource(TextBlocklist) +model TextBlockItem { + @doc("Block Item Id. It will be uuid.") + @key("blockItemId") + @visibility("read", "create", "query") + @maxLength(64) + blockItemId: string; + + @doc("Block item description.") + @maxLength(1024) + description?: string; + + @doc("Block item content.") + @maxLength(128) + text: string; +} + +@doc("Block item info in text blocklist.") +model TextBlockItemInfo { + @doc("Block item description.") + @maxLength(1024) + description?: string; + + @doc("Block item content.") + @maxLength(128) + text: string; +} + +@doc("The request of adding blockItems to text blocklist.") +model AddBlockItemsOptions { + @doc("Array of blockItemInfo to add.") + blockItems: TextBlockItemInfo[]; +} + +@doc("The response of adding blockItems to text blocklist.") +model AddBlockItemsResult { + @doc("Array of blockItems added.") + value?: TextBlockItem[]; +} + +@doc("The request of removing blockItems from text blocklist.") +model RemoveBlockItemsOptions { + @doc("Array of blockItemIds to remove.") + blockItemIds: string[]; +} diff --git a/specification/cognitiveservices/ContentSafety/routes.tsp b/specification/cognitiveservices/ContentSafety/routes.tsp new file mode 100644 index 000000000000..a8736c4483e4 --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/routes.tsp @@ -0,0 +1,89 @@ +import "@azure-tools/typespec-azure-core"; +import "@azure-tools/typespec-client-generator-core"; +import "@typespec/http"; +import "@typespec/rest"; +import "./models.tsp"; + +using TypeSpec.Http; +using TypeSpec.Rest; +using TypeSpec.Versioning; +using Azure.Core; +using Azure.Core.Traits; +using Azure.ClientGenerator.Core; + +namespace ContentSafety; + +interface TextOperations { + @summary("Analyze Text") + @doc("A sync API for harmful content analysis for text. Currently, we support four categories: Hate, SelfHarm, Sexual, Violence.") + @route("/text:analyze") + @post + analyzeText is Azure.Core.RpcOperation< + { + @body + @doc("The request of text analysis.") + body: AnalyzeTextOptions; + }, + AnalyzeTextResult + >; +} + +interface ImageOperations { + @summary("Analyze Image") + @doc("A sync API for harmful content analysis for image. Currently, we support four categories: Hate, SelfHarm, Sexual, Violence.") + @route("/image:analyze") + @post + analyzeImage is Azure.Core.RpcOperation< + { + @doc("The analysis request of the image.") + @body + body: AnalyzeImageOptions; + }, + AnalyzeImageResult + >; +} + +interface TextBlocklists { + @summary("Get Text Blocklist By blocklistName") + @doc("Returns text blocklist details.") + getTextBlocklist is Azure.Core.ResourceRead; + + @summary("Create Or Update Text Blocklist") + @doc("Updates a text blocklist, if blocklistName does not exist, create a new blocklist.") + createOrUpdateTextBlocklist is Azure.Core.ResourceCreateOrUpdate; + + @summary("Delete Text Blocklist By blocklistName") + @doc("Deletes a text blocklist.") + deleteTextBlocklist is Azure.Core.ResourceDelete; + + @summary("Get All Text Blocklists") + @doc("Get all text blocklists details.") + listTextBlocklists is Azure.Core.ResourceList; + + @summary("Add BlockItems To Text Blocklist") + @doc("Add blockItems to a text blocklist. You can add at most 100 BlockItems in one request.") + addBlockItems is ResourceAction< + TextBlocklist, + AddBlockItemsOptions, + AddBlockItemsResult + >; + + @summary("Remove BlockItems From Text Blocklist") + @doc("Remove blockItems from a text blocklist. You can remove at most 100 BlockItems in one request.") + removeBlockItems is ResourceAction< + TextBlocklist, + RemoveBlockItemsOptions, + NoContentResponse + >; + + @summary("Get BlockItem By blocklistName And blockItemId") + @doc("Get blockItem By blockItemId from a text blocklist.") + getTextBlocklistItem is Azure.Core.ResourceRead; + + @summary("Get All BlockItems By blocklistName") + @doc("Get all blockItems in a text blocklist") + listTextBlocklistItems is Azure.Core.ResourceList< + TextBlockItem, + ListQueryParametersTrait + >; +} diff --git a/specification/cognitiveservices/ContentSafety/tspconfig.yaml b/specification/cognitiveservices/ContentSafety/tspconfig.yaml new file mode 100644 index 000000000000..976e4bb86aa4 --- /dev/null +++ b/specification/cognitiveservices/ContentSafety/tspconfig.yaml @@ -0,0 +1,38 @@ +parameters: + python-sdk-folder: + default: "{cwd}/azure-sdk-for-python/" + # java-sdk-folder: + # default: "{cwd}/azure-sdk-for-java/" + # js-sdk-folder: + # default: "{cwd}/azure-sdk-for-js/" + csharp-sdk-folder: + default: "{cwd}/azure-sdk-for-csharp/" + service-directory-name: + default: "contentsafety" +emit: + - "@azure-tools/typespec-autorest" +options: + "@azure-tools/typespec-autorest": + output-file: "contentsafety.json" + azure-resource-provider-folder: ../../../../data-plane + examples-directory: ./examples + "@azure-tools/typespec-python": + package-name: "azure-ai-contentsafety" + emitter-output-dir: "{python-sdk-folder}/sdk/{service-directory-name}/{package-name}" + package-mode: dataplane + "@azure-tools/typespec-csharp": + namespace: "Azure.AI.ContentSafety" + clear-output-folder: true + model-namespace: false + emitter-output-dir: "{csharp-sdk-folder}/sdk/{service-directory-name}/{namespace}/src" + # "@azure-tools/cadl-typescript": + # emitter-output-dir: "{js-sdk-folder}/sdk/{service-directory-name}/contentsafety-rest" + # generateMetadata: true + # generateTest: true + # azureSdkForJs: true + # packageDetails: + # name: "@azure-rest/contentsafety-rest" + # description: "ContentSafety Service" + # "@azure-tools/cadl-java": + # emitter-output-dir: "{java-sdk-folder}/sdk/{service-directory-name}/contentsafety" + # namespace: com.contentsafety diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json new file mode 100644 index 000000000000..c365ee78d707 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json @@ -0,0 +1,1074 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContentSafety Service", + "version": "2023-04-30-preview", + "description": "Analyze harmful content", + "x-typespec-generated": [ + { + "emitter": "@azure-tools/typespec-autorest" + } + ] + }, + "schemes": [ + "https" + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/contentsafety", + "useSchemePrefix": false, + "parameters": [ + { + "name": "endpoint", + "in": "path", + "required": true, + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example:\nhttps://.cognitiveservices.azure.com).", + "type": "string" + } + ] + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "security": [ + { + "ApiKeyAuth": [] + } + ], + "securityDefinitions": { + "ApiKeyAuth": { + "type": "apiKey", + "in": "header", + "name": "Ocp-Apim-Subscription-Key" + } + }, + "tags": [], + "paths": { + "/image:analyze": { + "post": { + "operationId": "ImageOperations_AnalyzeImage", + "summary": "Analyze Image", + "description": "A sync API for harmful content analysis for image. Currently, we support four categories: Hate, SelfHarm, Sexual, Violence.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "description": "The analysis request of the image.", + "schema": { + "$ref": "#/definitions/AnalyzeImageOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeImageResult" + } + }, + "default": { + "description": "An unexpected error response.", + "headers": { + "x-ms-error-code": { + "description": "String error code indicating what went wrong.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze Image": { + "$ref": "./examples/AnalyzeImage.json" + } + } + } + }, + "/text/blocklists": { + "get": { + "operationId": "TextBlocklists_ListTextBlocklists", + "summary": "Get All Text Blocklists", + "description": "Get all text blocklists details.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TextBlocklist" + }, + "x-ms-identifiers": [], + "x-typespec-name": "TextBlocklist[]", + "description": "The TextBlocklist items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-typespec-name": "Rest.ResourceLocation" + } + }, + "description": "Paged collection of TextBlocklist items", + "required": [ + "value" + ], + "x-typespec-name": "Azure.Core.Foundations.CustomPage" + } + }, + "default": { + "description": "An unexpected error response.", + "headers": { + "x-ms-error-code": { + "description": "String error code indicating what went wrong.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get All Text Blocklists": { + "$ref": "./examples/ListTextBlocklists.json" + } + } + } + }, + "/text/blocklists/{blocklistName}": { + "get": { + "operationId": "TextBlocklists_GetTextBlocklist", + "summary": "Get Text Blocklist By blocklistName", + "description": "Returns text blocklist details.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "blocklistName", + "in": "path", + "required": true, + "description": "Text blocklist name.", + "pattern": "^[0-9A-Za-z._~-]+$", + "maxLength": 64, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TextBlocklist" + } + }, + "default": { + "description": "An unexpected error response.", + "headers": { + "x-ms-error-code": { + "description": "String error code indicating what went wrong.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Text Blocklist By blocklistName": { + "$ref": "./examples/GetTextBlocklist.json" + } + } + }, + "patch": { + "operationId": "TextBlocklists_CreateOrUpdateTextBlocklist", + "summary": "Create Or Update Text Blocklist", + "description": "Updates a text blocklist, if blocklistName does not exist, create a new blocklist.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "blocklistName", + "in": "path", + "required": true, + "description": "Text blocklist name.", + "pattern": "^[0-9A-Za-z._~-]+$", + "maxLength": 64, + "type": "string" + }, + { + "name": "resource", + "in": "body", + "required": true, + "description": "The resource instance.", + "schema": { + "$ref": "#/definitions/TextBlocklistUpdate" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TextBlocklist" + } + }, + "201": { + "description": "The request has succeeded and a new resource has been created as a result.", + "schema": { + "$ref": "#/definitions/TextBlocklist" + } + }, + "default": { + "description": "An unexpected error response.", + "headers": { + "x-ms-error-code": { + "description": "String error code indicating what went wrong.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + } + } + }, + "consumes": [ + "application/merge-patch+json" + ], + "x-ms-examples": { + "Create Or Update Text Blocklist": { + "$ref": "./examples/CreateOrUpdateTextBlocklist.json" + } + } + }, + "delete": { + "operationId": "TextBlocklists_DeleteTextBlocklist", + "summary": "Delete Text Blocklist By blocklistName", + "description": "Deletes a text blocklist.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "blocklistName", + "in": "path", + "required": true, + "description": "Text blocklist name.", + "pattern": "^[0-9A-Za-z._~-]+$", + "maxLength": 64, + "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.", + "headers": { + "x-ms-error-code": { + "description": "String error code indicating what went wrong.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Text Blocklist By blocklistName": { + "$ref": "./examples/DeleteTextBlocklist.json" + } + } + } + }, + "/text/blocklists/{blocklistName}:addBlockItems": { + "post": { + "operationId": "TextBlocklists_AddBlockItems", + "summary": "Add BlockItems To Text Blocklist", + "description": "Add blockItems to a text blocklist. You can add at most 100 BlockItems in one request.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "blocklistName", + "in": "path", + "required": true, + "description": "Text blocklist name.", + "pattern": "^[0-9A-Za-z._~-]+$", + "maxLength": 64, + "type": "string" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/AddBlockItemsOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AddBlockItemsResult" + } + }, + "default": { + "description": "An unexpected error response.", + "headers": { + "x-ms-error-code": { + "description": "String error code indicating what went wrong.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + } + } + }, + "x-ms-examples": { + "Add BlockItems To Text Blocklist": { + "$ref": "./examples/AddBlockItems.json" + } + } + } + }, + "/text/blocklists/{blocklistName}:removeBlockItems": { + "post": { + "operationId": "TextBlocklists_RemoveBlockItems", + "summary": "Remove BlockItems From Text Blocklist", + "description": "Remove blockItems from a text blocklist. You can remove at most 100 BlockItems in one request.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "blocklistName", + "in": "path", + "required": true, + "description": "Text blocklist name.", + "pattern": "^[0-9A-Za-z._~-]+$", + "maxLength": 64, + "type": "string" + }, + { + "name": "body", + "in": "body", + "schema": { + "$ref": "#/definitions/RemoveBlockItemsOptions" + } + } + ], + "responses": { + "204": { + "description": "There is no content to send for this request, but the headers may be useful. " + }, + "default": { + "description": "An unexpected error response.", + "headers": { + "x-ms-error-code": { + "description": "String error code indicating what went wrong.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + } + } + }, + "x-ms-examples": { + "Remove BlockItems From Text Blocklist": { + "$ref": "./examples/RemoveBlockItems.json" + } + } + } + }, + "/text/blocklists/{blocklistName}/blockItems": { + "get": { + "operationId": "TextBlocklists_ListTextBlocklistItems", + "summary": "Get All BlockItems By blocklistName", + "description": "Get all blockItems in a text blocklist", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "blocklistName", + "in": "path", + "required": true, + "description": "Text blocklist name.", + "pattern": "^[0-9A-Za-z._~-]+$", + "maxLength": 64, + "type": "string" + }, + { + "$ref": "#/parameters/Azure.Core.TopQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.SkipQueryParameter" + }, + { + "$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TextBlockItem" + }, + "x-ms-identifiers": [], + "x-typespec-name": "TextBlockItem[]", + "description": "The TextBlockItem items on this page" + }, + "nextLink": { + "type": "string", + "format": "uri", + "description": "The link to the next page of items", + "x-typespec-name": "Rest.ResourceLocation" + } + }, + "description": "Paged collection of TextBlockItem items", + "required": [ + "value" + ], + "x-typespec-name": "Azure.Core.Foundations.CustomPage" + } + }, + "default": { + "description": "An unexpected error response.", + "headers": { + "x-ms-error-code": { + "description": "String error code indicating what went wrong.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get All BlockItems By blocklistName": { + "$ref": "./examples/ListTextBlocklistItems.json" + } + } + } + }, + "/text/blocklists/{blocklistName}/blockItems/{blockItemId}": { + "get": { + "operationId": "TextBlocklists_GetTextBlocklistItem", + "summary": "Get BlockItem By blocklistName And blockItemId", + "description": "Get blockItem By blockItemId from a text blocklist.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "blocklistName", + "in": "path", + "required": true, + "description": "Text blocklist name.", + "pattern": "^[0-9A-Za-z._~-]+$", + "maxLength": 64, + "type": "string" + }, + { + "name": "blockItemId", + "in": "path", + "required": true, + "description": "Block Item Id. It will be uuid.", + "maxLength": 64, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/TextBlockItem" + } + }, + "default": { + "description": "An unexpected error response.", + "headers": { + "x-ms-error-code": { + "description": "String error code indicating what went wrong.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get BlockItem By blocklistName And blockItemId": { + "$ref": "./examples/GetTextBlocklistItem.json" + } + } + } + }, + "/text:analyze": { + "post": { + "operationId": "TextOperations_AnalyzeText", + "summary": "Analyze Text", + "description": "A sync API for harmful content analysis for text. Currently, we support four categories: Hate, SelfHarm, Sexual, Violence.", + "parameters": [ + { + "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" + }, + { + "name": "body", + "in": "body", + "required": true, + "description": "The request of text analysis.", + "schema": { + "$ref": "#/definitions/AnalyzeTextOptions" + } + } + ], + "responses": { + "200": { + "description": "The request has succeeded.", + "schema": { + "$ref": "#/definitions/AnalyzeTextResult" + } + }, + "default": { + "description": "An unexpected error response.", + "headers": { + "x-ms-error-code": { + "description": "String error code indicating what went wrong.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" + } + } + }, + "x-ms-examples": { + "Analyze Text": { + "$ref": "./examples/AnalyzeText.json" + } + } + } + } + }, + "definitions": { + "AddBlockItemsOptions": { + "type": "object", + "properties": { + "blockItems": { + "type": "array", + "items": { + "$ref": "#/definitions/TextBlockItemInfo" + }, + "x-ms-identifiers": [], + "x-typespec-name": "TextBlockItemInfo[]", + "description": "Array of blockItemInfo to add." + } + }, + "description": "The request of adding blockItems to text blocklist.", + "required": [ + "blockItems" + ] + }, + "AddBlockItemsResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TextBlockItem" + }, + "x-ms-identifiers": [], + "x-typespec-name": "TextBlockItem[]", + "description": "Array of blockItems added." + } + }, + "description": "The response of adding blockItems to text blocklist." + }, + "AnalyzeImageOptions": { + "type": "object", + "properties": { + "image": { + "$ref": "#/definitions/ImageData", + "description": "The image needs to be analyzed." + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageCategory" + }, + "x-typespec-name": "ImageCategory[]", + "description": "The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned." + } + }, + "description": "The analysis request of the image.", + "required": [ + "image" + ] + }, + "AnalyzeImageResult": { + "type": "object", + "properties": { + "hateResult": { + "$ref": "#/definitions/ImageAnalyzeSeverityResult", + "description": "Analysis result for Hate category." + }, + "selfHarmResult": { + "$ref": "#/definitions/ImageAnalyzeSeverityResult", + "description": "Analysis result for SelfHarm category." + }, + "sexualResult": { + "$ref": "#/definitions/ImageAnalyzeSeverityResult", + "description": "Analysis result for Sexual category." + }, + "violenceResult": { + "$ref": "#/definitions/ImageAnalyzeSeverityResult", + "description": "Analysis result for Violence category." + } + }, + "description": "The analysis response of the image." + }, + "AnalyzeTextOptions": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "The text needs to be scanned. We support at most 1000 characters (unicode code points) in text of one request.", + "maxLength": 1000 + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/TextCategory" + }, + "x-typespec-name": "TextCategory[]", + "description": "The categories will be analyzed. If not assigned, a default set of the categories' analysis results will be returned." + }, + "blocklistNames": { + "type": "array", + "items": { + "type": "string" + }, + "x-typespec-name": "string[]", + "description": "The names of blocklists." + }, + "breakByBlocklists": { + "type": "boolean", + "description": "When set to true, further analyses of harmful content will not be performed in cases where blocklists are hit. When set to false, all analyses of harmful content will be performed, whether or not blocklists are hit." + } + }, + "description": "The analysis request of the text.", + "required": [ + "text" + ] + }, + "AnalyzeTextResult": { + "type": "object", + "properties": { + "blocklistsMatchResults": { + "type": "array", + "items": { + "$ref": "#/definitions/TextBlocklistMatchResult" + }, + "x-ms-identifiers": [], + "x-typespec-name": "TextBlocklistMatchResult[]", + "description": "The details of blocklist match." + }, + "hateResult": { + "$ref": "#/definitions/TextAnalyzeSeverityResult", + "description": "Analysis result for Hate category." + }, + "selfHarmResult": { + "$ref": "#/definitions/TextAnalyzeSeverityResult", + "description": "Analysis result for SelfHarm category." + }, + "sexualResult": { + "$ref": "#/definitions/TextAnalyzeSeverityResult", + "description": "Analysis result for Sexual category." + }, + "violenceResult": { + "$ref": "#/definitions/TextAnalyzeSeverityResult", + "description": "Analysis result for Violence category." + } + }, + "description": "The analysis response of the text" + }, + "Azure.Core.Foundations.Error": { + "type": "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", + "items": { + "$ref": "#/definitions/Azure.Core.Foundations.Error" + }, + "x-ms-identifiers": [], + "x-typespec-name": "Azure.Core.Foundations.Error[]", + "description": "An array of details about specific errors that led to this reported error." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "An object containing more specific information than the current object about the error." + } + }, + "description": "The error object.", + "required": [ + "code", + "message", + "details" + ] + }, + "Azure.Core.Foundations.ErrorResponse": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Azure.Core.Foundations.Error", + "description": "The error object." + } + }, + "description": "A response containing error details.", + "required": [ + "error" + ] + }, + "Azure.Core.Foundations.InnerError": { + "type": "object", + "properties": { + "code": { + "type": "string", + "description": "One of a server-defined set of error codes." + }, + "innererror": { + "$ref": "#/definitions/Azure.Core.Foundations.InnerError", + "description": "Inner error." + } + }, + "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.", + "required": [ + "code" + ] + }, + "ImageAnalyzeSeverityResult": { + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/ImageCategory", + "description": "The image category." + }, + "severity": { + "type": "integer", + "format": "int32", + "description": "The higher the severity of input content, the larger this value, currently its value could be: 0,2,4,6." + } + }, + "description": "Image analysis result.", + "required": [ + "category", + "severity" + ] + }, + "ImageCategory": { + "type": "string", + "description": "Image analyze category", + "enum": [ + "Hate", + "SelfHarm", + "Sexual", + "Violence" + ], + "x-ms-enum": { + "name": "ImageCategory", + "modelAsString": true + } + }, + "ImageData": { + "type": "object", + "properties": { + "content": { + "type": "string", + "format": "byte", + "description": "Base64 encoding of image." + }, + "blobUrl": { + "type": "string", + "format": "uri", + "description": "The blob url of image." + } + }, + "description": "The content or blob url of image, could be base64 encoding bytes or blob url. If both are given, the request will be refused. The maximum size of image is 2048 pixels * 2048 pixels, no larger than 4MB at the same time. The minimum size of image is 50 pixels * 50 pixels." + }, + "RemoveBlockItemsOptions": { + "type": "object", + "properties": { + "blockItemIds": { + "type": "array", + "items": { + "type": "string" + }, + "x-typespec-name": "string[]", + "description": "Array of blockItemIds to remove." + } + }, + "description": "The request of removing blockItems from text blocklist.", + "required": [ + "blockItemIds" + ] + }, + "TextAnalyzeSeverityResult": { + "type": "object", + "properties": { + "category": { + "$ref": "#/definitions/TextCategory", + "description": "The text category." + }, + "severity": { + "type": "integer", + "format": "int32", + "description": "The higher the severity of input content, the larger this value is. The values could be: 0,2,4,6." + } + }, + "description": "Text analysis result.", + "required": [ + "category", + "severity" + ] + }, + "TextBlockItem": { + "type": "object", + "properties": { + "blockItemId": { + "type": "string", + "description": "Block Item Id. It will be uuid.", + "maxLength": 64, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "description": { + "type": "string", + "description": "Block item description.", + "maxLength": 1024 + }, + "text": { + "type": "string", + "description": "Block item content.", + "maxLength": 128 + } + }, + "description": "Item in TextBlocklist.", + "required": [ + "blockItemId", + "text" + ] + }, + "TextBlockItemInfo": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Block item description.", + "maxLength": 1024 + }, + "text": { + "type": "string", + "description": "Block item content.", + "maxLength": 128 + } + }, + "description": "Block item info in text blocklist.", + "required": [ + "text" + ] + }, + "TextBlocklist": { + "type": "object", + "properties": { + "blocklistName": { + "type": "string", + "description": "Text blocklist name.", + "pattern": "^[0-9A-Za-z._~-]+$", + "maxLength": 64, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "description": { + "type": "string", + "description": "Text blocklist description.", + "maxLength": 1024 + } + }, + "description": "Text Blocklist.", + "required": [ + "blocklistName" + ] + }, + "TextBlocklistMatchResult": { + "type": "object", + "properties": { + "blocklistName": { + "type": "string", + "description": "The name of matched blocklist.", + "maxLength": 64 + }, + "blockItemId": { + "type": "string", + "description": "The id of matched item.", + "maxLength": 64 + }, + "blockItemText": { + "type": "string", + "description": "The content of matched item.", + "maxLength": 128 + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The character offset of matched text in original input." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of matched text in original input." + } + }, + "description": "The result of blocklist match.", + "required": [ + "blocklistName", + "blockItemId", + "blockItemText", + "offset", + "length" + ] + }, + "TextBlocklistUpdate": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "Text blocklist description.", + "maxLength": 1024 + } + }, + "description": "Text Blocklist." + }, + "TextCategory": { + "type": "string", + "description": "Text analyze category", + "enum": [ + "Hate", + "SelfHarm", + "Sexual", + "Violence" + ], + "x-ms-enum": { + "name": "TextCategory", + "modelAsString": true + } + }, + "Versions": { + "type": "string", + "enum": [ + "2023-04-30-preview" + ], + "x-ms-enum": { + "name": "Versions", + "modelAsString": true, + "values": [ + { + "name": "v2023_04_30_Preview", + "value": "2023-04-30-preview" + } + ] + } + } + }, + "parameters": { + "Azure.Core.Foundations.ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "description": "The API version to use for this operation.", + "x-ms-client-name": "apiVersion", + "minLength": 1, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Azure.Core.MaxPageSizeQueryParameter": { + "name": "maxpagesize", + "in": "query", + "required": false, + "description": "The maximum number of result items per page.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.SkipQueryParameter": { + "name": "skip", + "in": "query", + "required": false, + "description": "The number of result items to skip.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "Azure.Core.TopQueryParameter": { + "name": "top", + "in": "query", + "required": false, + "description": "The number of result items to return.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AddBlockItems.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AddBlockItems.json new file mode 100644 index 000000000000..3670641ca73b --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AddBlockItems.json @@ -0,0 +1,29 @@ +{ + "title": "Add BlockItems To Text Blocklist", + "operationId": "TextBlocklists_AddBlockItems", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist", + "body": { + "blockItems": [ + { + "description": "Hate word", + "text": "hate" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "blockItemId": "9511969e-f1e3-4604-9127-05ee16c509ec", + "description": "Hate word", + "text": "hate" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AnalyzeImage.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AnalyzeImage.json new file mode 100644 index 000000000000..7224de71454c --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AnalyzeImage.json @@ -0,0 +1,34 @@ +{ + "title": "Analyze Image", + "operationId": "ImageOperations_AnalyzeImage", + "parameters": { + "api-version": "2023-04-30-preview", + "body": { + "image": { + "content": "Y29udGVudDE=" + } + } + }, + "responses": { + "200": { + "body": { + "hateResult": { + "category": "Hate", + "severity": 0 + }, + "selfHarmResult": { + "category": "Hate", + "severity": 0 + }, + "sexualResult": { + "category": "Hate", + "severity": 0 + }, + "violenceResult": { + "category": "Hate", + "severity": 2 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AnalyzeText.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AnalyzeText.json new file mode 100644 index 000000000000..5d5bf56e9fcf --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/AnalyzeText.json @@ -0,0 +1,33 @@ +{ + "title": "Analyze Text", + "operationId": "TextOperations_AnalyzeText", + "parameters": { + "api-version": "2023-04-30-preview", + "body": { + "text": "This is text example" + } + }, + "responses": { + "200": { + "body": { + "blocklistsMatchResults": [], + "hateResult": { + "category": "Hate", + "severity": 0 + }, + "selfHarmResult": { + "category": "SelfHarm", + "severity": 0 + }, + "sexualResult": { + "category": "Sexual", + "severity": 0 + }, + "violenceResult": { + "category": "Violence", + "severity": 0 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/CreateOrUpdateTextBlocklist.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/CreateOrUpdateTextBlocklist.json new file mode 100644 index 000000000000..c20bc792687d --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/CreateOrUpdateTextBlocklist.json @@ -0,0 +1,25 @@ +{ + "title": "Create Or Update Text Blocklist", + "operationId": "TextBlocklists_CreateOrUpdateTextBlocklist", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist", + "resource": { + "description": "Test Blocklist" + } + }, + "responses": { + "200": { + "body": { + "blocklistName": "TestBlocklist", + "description": "Test Blocklist" + } + }, + "201": { + "body": { + "blocklistName": "TestBlocklist", + "description": "Test Blocklist" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/DeleteTextBlocklist.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/DeleteTextBlocklist.json new file mode 100644 index 000000000000..c671893d679a --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/DeleteTextBlocklist.json @@ -0,0 +1,11 @@ +{ + "title": "Delete Text Blocklist By blocklistName", + "operationId": "TextBlocklists_DeleteTextBlocklist", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/GetTextBlocklist.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/GetTextBlocklist.json new file mode 100644 index 000000000000..4969426906de --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/GetTextBlocklist.json @@ -0,0 +1,16 @@ +{ + "title": "Get Text Blocklist By blocklistName", + "operationId": "TextBlocklists_GetTextBlocklist", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist" + }, + "responses": { + "200": { + "body": { + "blocklistName": "TestBlocklist", + "description": "Test Blocklist" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/GetTextBlocklistItem.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/GetTextBlocklistItem.json new file mode 100644 index 000000000000..94da2bfbdaa9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/GetTextBlocklistItem.json @@ -0,0 +1,18 @@ +{ + "title": "Get BlockItem By blocklistName And blockItemId", + "operationId": "TextBlocklists_GetTextBlocklistItem", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist", + "blockItemId": "9511969e-f1e3-4604-9127-05ee16c509ec" + }, + "responses": { + "200": { + "body": { + "blockItemId": "9511969e-f1e3-4604-9127-05ee16c509ec", + "description": "Hate word", + "text": "hate" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/ListTextBlocklistItems.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/ListTextBlocklistItems.json new file mode 100644 index 000000000000..6c7955b98842 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/ListTextBlocklistItems.json @@ -0,0 +1,21 @@ +{ + "title": "Get All BlockItems By blocklistName", + "operationId": "TextBlocklists_ListTextBlocklistItems", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "blockItemId": "9511969e-f1e3-4604-9127-05ee16c509ec", + "description": "Hate word", + "text": "hate" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/ListTextBlocklists.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/ListTextBlocklists.json new file mode 100644 index 000000000000..ea72669941d3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/ListTextBlocklists.json @@ -0,0 +1,19 @@ +{ + "title": "Get All Text Blocklists", + "operationId": "TextBlocklists_ListTextBlocklists", + "parameters": { + "api-version": "2023-04-30-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "blocklistName": "TestBlocklist", + "description": "Test Blocklist" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/RemoveBlockItems.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/RemoveBlockItems.json new file mode 100644 index 000000000000..fc7ea3a3fea3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/examples/RemoveBlockItems.json @@ -0,0 +1,16 @@ +{ + "title": "Remove BlockItems From Text Blocklist", + "operationId": "TextBlocklists_RemoveBlockItems", + "parameters": { + "api-version": "2023-04-30-preview", + "blocklistName": "TestBlocklist", + "body": { + "blockItemIds": [ + "9511969e-f1e3-4604-9127-05ee16c509ec" + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/ContentSafety/readme.md b/specification/cognitiveservices/data-plane/ContentSafety/readme.md new file mode 100644 index 000000000000..73b2584538b3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/ContentSafety/readme.md @@ -0,0 +1,78 @@ +# Content Safety + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Content Safety. + +## Getting Started + +To build the SDKs for My API, simply install AutoRest via `npm` (`npm install -g autorest`) and then run: + +> `autorest readme.md` + +To see additional help and options, run: + +> `autorest --help` + +For other options on installation see [Installing AutoRest](https://aka.ms/autorest/install) on the AutoRest github page. + +--- + +## Configuration + +### Basic Information + +These are the global settings for the Content Safety. + +```yaml +openapi-type: data-plane +tag: package-2023-04-30-preview +``` + +### Tag: package-2023-04-30-preview + +These settings apply only when `--tag=package-2023-04-30-preview` is specified on the command line. + +```yaml $(tag) == 'package-2023-04-30-preview' +input-file: + - preview/2023-04-30-preview/contentsafety.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python-track2 + - repo: azure-sdk-for-net-track2 + - repo: azure-sdk-for-java + - repo: azure-sdk-for-js + - repo: azure-resource-manager-schemas + - repo: azure-cli-extensions + - repo: azure-powershell +``` +## Az + +See configuration in [readme.az.md](./readme.az.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## TypeScript + +See configuration in [readme.typescript.md](./readme.typescript.md) + +## CSharp + +See configuration in [readme.csharp.md](./readme.csharp.md) \ No newline at end of file From 5c021b26d815babdb06989b25fbb834cbbe7ba6b Mon Sep 17 00:00:00 2001 From: xiaoxu qi Date: Tue, 9 May 2023 13:16:20 +0800 Subject: [PATCH 50/79] add network when updating server (#23839) * add network when updating server * fix linter --- .../preview/2022-09-30-preview/FlexibleServers.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json index 17751dc26140..5b2b54d9edfc 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/FlexibleServers/preview/2022-09-30-preview/FlexibleServers.json @@ -1095,6 +1095,10 @@ "dataEncryption": { "$ref": "#/definitions/DataEncryption", "description": "The Data Encryption for CMK." + }, + "network": { + "$ref": "#/definitions/Network", + "description": "Network related properties of a server" } }, "description": "The properties that can be updated for a server." From b968c095c748b92ac887553f0652614838d651ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B3=BD=E5=8D=8E?= <18810723551@163.com> Date: Tue, 9 May 2023 14:15:58 +0800 Subject: [PATCH 51/79] [Hub Generated] Publish private branch 'datafactory/zehuachen/MongoDbAtlasSwaggerUpdate' (#23853) * [AutoSync] d2f2fcc053 mongoDbAtlas Swagger Update * [AutoSync] 209ea93352 refine description in mongoDbAtlasDriverVersion --------- Co-authored-by: swagger-automation --- .../stable/2018-06-01/entityTypes/LinkedService.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index cccd0a91eef9..c687f8015709 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -2535,6 +2535,11 @@ "type": "object", "x-ms-format": "dfe-string", "description": "The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string)." + }, + "mongoDbAtlasDriverVersion": { + "type": "object", + "x-ms-format": "dfe-string", + "description": "The MongoDB Atlas Driver version that you want to choose. Allowed value are 2.10.4 and 2.19.0. Type: string (or Expression with resultType string)." } }, "required": [ From 06bf50ba45fe22722dfc6340b58fe45a3a71f7c6 Mon Sep 17 00:00:00 2001 From: amchandn <43201777+amchandn@users.noreply.github.com> Date: Tue, 9 May 2023 11:49:31 +0530 Subject: [PATCH 52/79] [Hub Generated] Review request for Microsoft.DataProtection to add version preview/2023-04-01-preview (#23391) * Adds base for updating Microsoft.DataProtection from version stable/2023-01-01 to version 2023-04-01-preview * Updates readme * Updates API version in new specs and examples * Adding fields for UserAssignedIdentity * Adding Secure Score for Backup vault * Adding fetchSecondaryRecoveryPoints * Removing cmk fields * Updating identity type description * Adding api for trigger crr * Adding validate crr api * Adding CRR jobs APIs * Adding default response * Using right contract for CRR jobs * Adding request * Adding examples * Example changes * empty examples * prettify json * Adding example content * FIxing example * changes * Fixing lintDiff violation * Adding missing API * swagger changes * Adding example * Spell check fix * Adding back validate object * Renaming * Prettier * changes * Added secure score * Improvements to example and description * Rename add prefix * Enabling x-ms-skip-url-encoding for ResourceId * reverting encoding skip * reverting encoding skip * Enabling x-ms-skip-url-encoding for ResourceId --- .../2023-04-01-preview/dataprotection.json | 7957 +++++++++++++++++ .../DeleteBackupInstance.json | 20 + .../FindRestorableTimeRanges.json | 32 + .../GetBackupInstance.json | 51 + .../GetBackupInstanceOperationResult.json | 56 + .../GetRecoveryPoint.json | 39 + .../ListBackupInstances.json | 54 + .../ListBackupInstancesExtensionRouting.json | 59 + .../ListRecoveryPoints.json | 68 + .../PutBackupInstance.json | 167 + .../ResumeBackups.json | 19 + .../ResumeProtection.json | 19 + .../StopProtection.json | 19 + .../SuspendBackups.json | 19 + .../SyncBackupInstance.json | 22 + .../TriggerBackup.json | 32 + .../TriggerRehydrate.json | 24 + .../TriggerRestore.json | 60 + .../TriggerRestoreAsFiles.json | 40 + .../TriggerRestoreWithRehydration.json | 55 + .../ValidateForBackup.json | 58 + .../ValidateRestore.json | 62 + .../examples/CheckfeatureSupport.json | 31 + .../FetchCrossRegionRestoreJob.json | 60 + .../FetchCrossRegionRestoreJobs.json | 139 + .../CrossRegionRestore/FetchSecondaryRPs.json | 71 + .../TriggerCrossRegionRestore.json | 67 + .../ValidateCrossRegionRestore.json | 67 + .../GetDeletedBackupInstance.json | 53 + .../ListDeletedBackupInstances.json | 56 + .../UndeleteDeletedBackupInstance.json | 19 + .../examples/GetOperationResult.json | 23 + .../examples/GetOperationStatus.json | 19 + .../examples/GetOperationStatusRGContext.json | 19 + .../GetOperationStatusVaultContext.json | 20 + .../JobCRUD/GetExportJobsOperationResult.json | 26 + .../examples/JobCRUD/GetJob.json | 56 + .../examples/JobCRUD/ListJobs.json | 135 + .../examples/JobCRUD/TriggerExportJobs.json | 17 + .../examples/Operations/List.json | 533 ++ .../CreateOrUpdateBackupPolicy.json | 200 + .../PolicyCRUD/DeleteBackupPolicy.json | 13 + .../examples/PolicyCRUD/GetBackupPolicy.json | 109 + .../examples/PolicyCRUD/ListBackupPolicy.json | 112 + .../DeleteResourceGuard.json | 12 + .../GetDefaultBackupSecurityPINRequests.json | 18 + ...GetDefaultDeleteProtectedItemRequests.json | 18 + ...faultDeleteResourceGuardProxyRequests.json | 18 + .../GetDefaultDisableSoftDeleteRequests.json | 18 + ...GetDefaultUpdateProtectedItemRequests.json | 18 + ...DefaultUpdateProtectionPolicyRequests.json | 18 + .../ResourceGuardCRUD/GetResourceGuard.json | 37 + .../GetResourceGuardsInResourceGroup.json | 40 + .../GetResourceGuardsInSubscription.json | 39 + .../ListBackupSecurityPINRequests.json | 21 + .../ListDeleteProtectedItemRequests.json | 21 + .../ListDeleteResourceGuardProxyRequests.json | 21 + .../ListDisableSoftDeleteRequests.json | 21 + .../ListUpdateProtectedItemRequests.json | 21 + .../ListUpdateProtectionPolicyRequests.json | 21 + .../ResourceGuardCRUD/PatchResourceGuard.json | 41 + .../ResourceGuardCRUD/PutResourceGuard.json | 70 + .../DeleteResourceGuardProxy.json | 13 + .../GetResourceGuardProxy.json | 33 + .../ListResourceGuardProxy.json | 36 + .../PutResourceGuardProxy.json | 38 + .../UnlockDeleteResourceGuardProxy.json | 22 + .../CheckBackupVaultsNameAvailability.json | 19 + .../examples/VaultCRUD/DeleteBackupVault.json | 19 + .../examples/VaultCRUD/GetBackupVault.json | 50 + .../VaultCRUD/GetBackupVaultWithMSI.json | 47 + .../GetBackupVaultsInResourceGroup.json | 88 + .../GetBackupVaultsInSubscription.json | 80 + .../VaultCRUD/GetOperationResultPatch.json | 46 + .../examples/VaultCRUD/PatchBackupVault.json | 55 + .../examples/VaultCRUD/PutBackupVault.json | 123 + .../VaultCRUD/PutBackupVaultWithMSI.json | 125 + .../dataprotection/resource-manager/readme.md | 13 +- 78 files changed, 12055 insertions(+), 2 deletions(-) create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/dataprotection.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/DeleteBackupInstance.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetBackupInstance.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetRecoveryPoint.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListBackupInstances.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListRecoveryPoints.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/PutBackupInstance.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ResumeBackups.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ResumeProtection.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/StopProtection.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/SuspendBackups.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/SyncBackupInstance.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerBackup.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRehydrate.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestore.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ValidateForBackup.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ValidateRestore.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CheckfeatureSupport.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchCrossRegionRestoreJob.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchCrossRegionRestoreJobs.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchSecondaryRPs.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/TriggerCrossRegionRestore.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/ValidateCrossRegionRestore.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationResult.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatus.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatusRGContext.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatusVaultContext.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/GetExportJobsOperationResult.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/GetJob.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/ListJobs.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/TriggerExportJobs.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/Operations/List.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/DeleteBackupPolicy.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/GetBackupPolicy.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/ListBackupPolicy.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/DeleteResourceGuard.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuard.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/PatchResourceGuard.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/PutResourceGuard.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/DeleteBackupVault.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVault.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultWithMSI.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultsInSubscription.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetOperationResultPatch.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PatchBackupVault.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PutBackupVault.json create mode 100644 specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PutBackupVaultWithMSI.json diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/dataprotection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/dataprotection.json new file mode 100644 index 000000000000..1bb2efdebd76 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/dataprotection.json @@ -0,0 +1,7957 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-01-preview", + "title": "DataProtectionBackupClient", + "x-ms-code-generation-settings": { + "internalConstructors": false + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/backupVaults": { + "get": { + "tags": [ + "BackupVaults" + ], + "description": "Returns resource collection belonging to a subscription.", + "operationId": "BackupVaults_GetInSubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get BackupVaults in Subscription": { + "$ref": "./examples/VaultCRUD/GetBackupVaultsInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationResults/{operationId}": { + "get": { + "tags": [ + "GetOperationResult" + ], + "description": "Gets the operation result for a resource", + "operationId": "OperationResult_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "summary": "Gets the operation status for a resource.", + "x-ms-examples": { + "Get OperationResult": { + "$ref": "./examples/GetOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/operationStatus/{operationId}": { + "get": { + "tags": [ + "OperationStatus" + ], + "summary": "Gets the operation status for a resource.", + "operationId": "OperationStatus_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/GetOperationStatus.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationStatus/{operationId}": { + "get": { + "tags": [ + "OperationStatus" + ], + "summary": "Gets the operation status for an operation over a BackupVault's context.", + "operationId": "OperationStatusBackupVaultContext_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/GetOperationStatusVaultContext.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/operationStatus/{operationId}": { + "get": { + "tags": [ + "OperationStatus" + ], + "summary": "Gets the operation status for an operation over a ResourceGroup's context.", + "operationId": "OperationStatusResourceGroupContext_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get OperationStatus": { + "$ref": "./examples/GetOperationStatusRGContext.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults": { + "get": { + "tags": [ + "BackupVaults" + ], + "description": "Returns resource collection belonging to a resource group.", + "operationId": "BackupVaults_GetInResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get BackupVaults in ResourceGroup": { + "$ref": "./examples/VaultCRUD/GetBackupVaultsInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}": { + "get": { + "tags": [ + "BackupVaults" + ], + "description": "Returns a resource belonging to a resource group.", + "operationId": "BackupVaults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get BackupVault": { + "$ref": "./examples/VaultCRUD/GetBackupVault.json" + }, + "Get BackupVault With MSI": { + "$ref": "./examples/VaultCRUD/GetBackupVaultWithMSI.json" + } + } + }, + "put": { + "tags": [ + "BackupVaults" + ], + "description": "Creates or updates a BackupVault resource belonging to a resource group.", + "operationId": "BackupVaults_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create BackupVault": { + "$ref": "./examples/VaultCRUD/PutBackupVault.json" + }, + "Create BackupVault With MSI": { + "$ref": "./examples/VaultCRUD/PutBackupVaultWithMSI.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "BackupVaults" + ], + "description": "Deletes a BackupVault resource from the resource group.", + "operationId": "BackupVaults_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete BackupVault": { + "$ref": "./examples/VaultCRUD/DeleteBackupVault.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "BackupVaults" + ], + "description": "Updates a BackupVault resource belonging to a resource group. For example, updating tags for a resource.", + "operationId": "BackupVaults_Update", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceRequestInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Patch BackupVault": { + "$ref": "./examples/VaultCRUD/PatchBackupVault.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/operationResults/{operationId}": { + "get": { + "tags": [ + "Resources" + ], + "operationId": "BackupVaultOperationResults_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupVaultResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetOperationResult Patch": { + "$ref": "./examples/VaultCRUD/GetOperationResultPatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "BackupVaults" + ], + "summary": "API to check for resource name availability", + "operationId": "BackupVaults_CheckNameAvailability", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "The location in which uniqueness will be verified.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Check name availability request", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check BackupVaults name availability": { + "$ref": "./examples/VaultCRUD/CheckBackupVaultsNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/locations/{location}/checkFeatureSupport": { + "post": { + "tags": [ + "DppFeatureSupport" + ], + "summary": "Validates if a feature is supported", + "operationId": "DataProtection_CheckFeatureSupport", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Feature support request object", + "required": true, + "schema": { + "$ref": "#/definitions/FeatureValidationRequestBase" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FeatureValidationResponseBase" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check Azure Vm Backup Feature Support": { + "$ref": "./examples/CheckfeatureSupport.json" + } + } + } + }, + "/providers/Microsoft.DataProtection/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Returns the list of available operations.", + "operationId": "DataProtectionOperations_List", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ClientDiscoveryResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "x-ms-examples": { + "Returns the list of supported REST operations.": { + "$ref": "./examples/Operations/List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies": { + "get": { + "tags": [ + "BackupPolicies" + ], + "description": "Returns list of backup policies belonging to a backup vault", + "operationId": "BackupPolicies_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List BackupPolicy": { + "$ref": "./examples/PolicyCRUD/ListBackupPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupPolicies/{backupPolicyName}": { + "get": { + "tags": [ + "BackupPolicies" + ], + "operationId": "BackupPolicies_Get", + "description": "Gets a backup policy belonging to a backup vault", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "summary": "Gets a backup policy belonging to a backup vault", + "x-ms-examples": { + "Get BackupPolicy": { + "$ref": "./examples/PolicyCRUD/GetBackupPolicy.json" + } + } + }, + "put": { + "tags": [ + "BackupPolicies" + ], + "operationId": "BackupPolicies_CreateOrUpdate", + "summary": "Creates or Updates a backup policy belonging to a backup vault", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupPolicyName", + "description": "Name of the policy", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BaseBackupPolicyResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CreateOrUpdate BackupPolicy": { + "$ref": "./examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json" + } + } + }, + "delete": { + "tags": [ + "BackupPolicies" + ], + "operationId": "BackupPolicies_Delete", + "summary": "Deletes a backup policy belonging to a backup vault", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupPolicyName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete BackupPolicy": { + "$ref": "./examples/PolicyCRUD/DeleteBackupPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances": { + "get": { + "tags": [ + "BackupInstances" + ], + "description": "Gets a backup instances belonging to a backup vault", + "operationId": "BackupInstances_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List BackupInstances in a Vault": { + "$ref": "./examples/BackupInstanceOperations/ListBackupInstances.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}": { + "get": { + "tags": [ + "BackupInstances" + ], + "description": "Gets a backup instance with name in a backup vault", + "operationId": "BackupInstances_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/GetBackupInstance.json" + } + } + }, + "put": { + "tags": [ + "BackupInstances" + ], + "description": "Create or update a backup instance in a backup vault", + "operationId": "BackupInstances_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "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": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/PutBackupInstance.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "BackupInstances" + ], + "description": "Delete a backup instance in a backup vault", + "operationId": "BackupInstances_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + } + ], + "responses": { + "200": { + "description": "Ok" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/DeleteBackupInstance.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/backup": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Trigger adhoc backup ", + "operationId": "BackupInstances_AdhocBackup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/TriggerBackupRequest" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Trigger Adhoc Backup": { + "$ref": "./examples/BackupInstanceOperations/TriggerBackup.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/validateForBackup": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Validate whether adhoc backup will be successful or not", + "operationId": "BackupInstances_ValidateForBackup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateForBackupRequest" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Validate For Backup": { + "$ref": "./examples/BackupInstanceOperations/ValidateForBackup.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/operationResults/{operationId}": { + "get": { + "tags": [ + "BackupInstances" + ], + "description": "Get result of backup instance creation operation", + "operationId": "BackupInstances_GetBackupInstanceOperationResult", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get BackupInstanceOperationResult": { + "$ref": "./examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints": { + "get": { + "tags": [ + "RecoveryPoint" + ], + "description": "Returns a list of Recovery Points for a DataSource in a vault.", + "operationId": "RecoveryPoints_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupRecoveryPointResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RecoveryPointsFilters", + "x-ms-examples": { + "List Recovery Points in a Vault": { + "$ref": "./examples/BackupInstanceOperations/ListRecoveryPoints.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/recoveryPoints/{recoveryPointId}": { + "get": { + "tags": [ + "RecoveryPoint" + ], + "description": "Gets a Recovery Point using recoveryPointId for a Datasource.", + "operationId": "RecoveryPoints_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "name": "recoveryPointId", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupRecoveryPointResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Recovery Point": { + "$ref": "./examples/BackupInstanceOperations/GetRecoveryPoint.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchSecondaryRecoveryPoints": { + "post": { + "tags": [ + "FetchSecondaryRecoveryPoints" + ], + "description": "Returns a list of Secondary Recovery Points for a DataSource in a vault, that can be used for Cross Region Restore.", + "operationId": "SecondaryRPs_Fetch", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/FetchSecondaryRPsRequestParameters" + } + }, + { + "name": "$filter", + "in": "query", + "description": "OData filter options.", + "required": false, + "type": "string" + }, + { + "name": "$skipToken", + "in": "query", + "description": "skipToken Filter.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupRecoveryPointResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/RecoveryPointsFilters", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Fetch SecondaryRPs": { + "$ref": "./examples/CrossRegionRestore/FetchSecondaryRPs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/crossRegionRestore": { + "post": { + "tags": [ + "BackupInstances" + ], + "operationId": "BackupInstances_TriggerCrossRegionRestore", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for trigger CRR operation", + "required": true, + "schema": { + "$ref": "#/definitions/CrossRegionRestoreRequestObject" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Trigger Cross Region Restore": { + "$ref": "./examples/CrossRegionRestore/TriggerCrossRegionRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/validateCrossRegionRestore": { + "post": { + "tags": [ + "BackupInstances" + ], + "operationId": "BackupInstances_ValidateCrossRegionRestore", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateCrossRegionRestoreRequestObject" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Validate Cross Region Restore": { + "$ref": "./examples/CrossRegionRestore/ValidateCrossRegionRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchCrossRegionRestoreJob": { + "post": { + "tags": [ + "DppJob" + ], + "operationId": "CrossRegionRestoreJob_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/CrossRegionRestoreJobRequest" + } + } + ], + "responses": { + "200": { + "description": "Details about a Cross Region Restore Job", + "schema": { + "$ref": "#/definitions/AzureBackupJobResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Cross Region Restore Job": { + "$ref": "./examples/CrossRegionRestore/FetchCrossRegionRestoreJob.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/locations/{location}/fetchCrossRegionRestoreJobs": { + "post": { + "tags": [ + "DppJob" + ], + "operationId": "CrossRegionRestoreJobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/CrossRegionRestoreJobsRequest" + } + } + ], + "responses": { + "200": { + "description": "List of Cross Region Restore Jobs", + "schema": { + "$ref": "#/definitions/AzureBackupJobResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Cross Region Restore Jobs": { + "$ref": "./examples/CrossRegionRestore/FetchCrossRegionRestoreJobs.json" + } + } + } + }, + "/{resourceId}/providers/Microsoft.DataProtection/backupInstances": { + "get": { + "tags": [ + "BackupInstancesExtensionRouting" + ], + "description": "Gets a list of backup instances associated with a tracked resource", + "operationId": "BackupInstancesExtensionRouting_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BackupInstanceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List BackupInstances associated with an azure resource": { + "$ref": "./examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/rehydrate": { + "post": { + "description": "rehydrate recovery point for restore for a BackupInstance", + "operationId": "BackupInstances_TriggerRehydrate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "description": "Request body for operation", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBackupRehydrationRequest" + } + }, + { + "$ref": "#/parameters/BackupInstanceName" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "tags": [ + "BackupInstances" + ], + "x-ms-examples": { + "Trigger Rehydrate": { + "$ref": "./examples/BackupInstanceOperations/TriggerRehydrate.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/restore": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Triggers restore for a BackupInstance", + "operationId": "BackupInstances_TriggerRestore", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBackupRestoreRequest" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Trigger Restore": { + "$ref": "./examples/BackupInstanceOperations/TriggerRestore.json" + }, + "Trigger Restore As Files": { + "$ref": "./examples/BackupInstanceOperations/TriggerRestoreAsFiles.json" + }, + "Trigger Restore With Rehydration": { + "$ref": "./examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeBackups": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will resume backups for backup instance", + "operationId": "BackupInstances_ResumeBackups", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ResumeBackups": { + "$ref": "./examples/BackupInstanceOperations/ResumeBackups.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/resumeProtection": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will resume protection for a stopped backup instance", + "operationId": "BackupInstances_ResumeProtection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ResumeProtection": { + "$ref": "./examples/BackupInstanceOperations/ResumeProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/stopProtection": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will stop protection of a backup instance and data will be held forever", + "operationId": "BackupInstances_StopProtection", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "StopProtection": { + "$ref": "./examples/BackupInstanceOperations/StopProtection.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/suspendBackups": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)", + "operationId": "BackupInstances_SuspendBackups", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SuspendBackups": { + "$ref": "./examples/BackupInstanceOperations/SuspendBackups.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/sync": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Sync backup instance again in case of failure\r\nThis action will retry last failed operation and will bring backup instance to valid state", + "operationId": "BackupInstances_SyncBackupInstance", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/SyncBackupInstanceRequest" + } + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Sync BackupInstance": { + "$ref": "./examples/BackupInstanceOperations/SyncBackupInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/validateRestore": { + "post": { + "tags": [ + "BackupInstances" + ], + "description": "Validates if Restore can be triggered for a DataSource", + "operationId": "BackupInstances_ValidateForRestore", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateRestoreRequestObject" + } + } + ], + "responses": { + "200": { + "description": "Contains additional information like job Id", + "schema": { + "$ref": "#/definitions/OperationJobExtendedInfo" + } + }, + "202": { + "description": "The operation will be completed asynchronously.", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Azure-AsyncOperation": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Validate Restore": { + "$ref": "./examples/BackupInstanceOperations/ValidateRestore.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs": { + "get": { + "tags": [ + "AzureBackupJobs" + ], + "description": "Returns list of jobs belonging to a backup vault", + "operationId": "Jobs_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupJobResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Jobs": { + "$ref": "./examples/JobCRUD/ListJobs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupInstances/{backupInstanceName}/findRestorableTimeRanges": { + "post": { + "tags": [ + "FindRestorableTimeRanges" + ], + "operationId": "RestorableTimeRanges_Find", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "#/parameters/BackupInstanceName" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Find Restorable Time Ranges": { + "$ref": "./examples/BackupInstanceOperations/FindRestorableTimeRanges.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/{jobId}": { + "get": { + "tags": [ + "AzureBackupJob" + ], + "description": "Gets a job with id in a backup vault", + "operationId": "Jobs_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "jobId", + "description": "The Job ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBackupJobResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Job": { + "$ref": "./examples/JobCRUD/GetJob.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/exportBackupJobs": { + "post": { + "tags": [ + "AzureBackupJob" + ], + "description": "Triggers export of jobs and returns an OperationID to track.", + "operationId": "ExportJobs_Trigger", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "The URL of the resource used to check the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Trigger Export Jobs": { + "$ref": "./examples/JobCRUD/TriggerExportJobs.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupJobs/operations/{operationId}": { + "get": { + "tags": [ + "AzureBackupJob" + ], + "description": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.", + "operationId": "ExportJobsOperationResult_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "operationId", + "description": "OperationID which represents the export job.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExportJobsResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Export Jobs Operation Result": { + "$ref": "./examples/JobCRUD/GetExportJobsOperationResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances": { + "get": { + "tags": [ + "DeletedBackupInstances" + ], + "description": "Gets deleted backup instances belonging to a backup vault", + "operationId": "DeletedBackupInstances_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeletedBackupInstanceResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List DeletedBackupInstances in a Vault": { + "$ref": "./examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}": { + "get": { + "tags": [ + "DeletedBackupInstances" + ], + "description": "Gets a deleted backup instance with name in a backup vault", + "operationId": "DeletedBackupInstances_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the deleted backup instance", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DeletedBackupInstanceResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DeletedBackupInstance": { + "$ref": "./examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/deletedBackupInstances/{backupInstanceName}/undelete": { + "post": { + "tags": [ + "DeletedBackupInstances" + ], + "operationId": "DeletedBackupInstances_Undelete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "backupInstanceName", + "description": "The name of the deleted backup instance", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Undelete Deleted BackupInstance": { + "$ref": "./examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataProtection/resourceGuards": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns ResourceGuards collection belonging to a subscription.", + "operationId": "ResourceGuards_GetResourcesInSubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get ResourceGuards in Subscription": { + "$ref": "./examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns ResourceGuards collection belonging to a ResourceGroup.", + "operationId": "ResourceGuards_GetResourcesInResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get ResourceGuards in ResourceGroup": { + "$ref": "./examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}": { + "put": { + "tags": [ + "ResourceGuards" + ], + "summary": "Creates or updates a ResourceGuard resource belonging to a resource group.", + "operationId": "ResourceGuards_Put", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "The name of ResourceGuard", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGuardResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ResourceGuardResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create ResourceGuard": { + "$ref": "./examples/ResourceGuardCRUD/PutResourceGuard.json" + } + } + }, + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns a ResourceGuard belonging to a resource group.", + "operationId": "ResourceGuards_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "The name of ResourceGuard", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ResourceGuard": { + "$ref": "./examples/ResourceGuardCRUD/GetResourceGuard.json" + } + } + }, + "delete": { + "tags": [ + "ResourceGuards" + ], + "summary": "Deletes a ResourceGuard resource from the resource group.", + "operationId": "ResourceGuards_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "The name of ResourceGuard", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete ResourceGuard": { + "$ref": "./examples/ResourceGuardCRUD/DeleteResourceGuard.json" + } + } + }, + "patch": { + "tags": [ + "ResourceGuards" + ], + "summary": "Updates a ResourceGuard resource belonging to a resource group. For example, updating tags for a resource.", + "operationId": "ResourceGuards_Patch", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "The name of ResourceGuard", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/PatchResourceGuardInput" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Patch ResourceGuard": { + "$ref": "./examples/ResourceGuardCRUD/PatchResourceGuard.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDisableSoftDeleteRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDeleteResourceGuardProxyRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetBackupSecurityPINRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDeleteProtectedItemRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetUpdateProtectionPolicyRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetUpdateProtectedItemRequestsObjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List OperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/disableSoftDeleteRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultDisableSoftDeleteRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteResourceGuardProxyRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultDeleteResourceGuardProxyRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/getBackupSecurityPINRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultBackupSecurityPINRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/deleteProtectedItemRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultDeleteProtectedItemRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectionPolicyRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultUpdateProtectionPolicyRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/resourceGuards/{resourceGuardsName}/updateProtectedItemRequests/{requestName}": { + "get": { + "tags": [ + "ResourceGuards" + ], + "summary": "Returns collection of operation request objects for a critical operation protected by the given ResourceGuard resource.", + "operationId": "ResourceGuards_GetDefaultUpdateProtectedItemRequestsObject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGuardsName", + "in": "path", + "description": "", + "required": true, + "type": "string" + }, + { + "name": "requestName", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DefaultOperationsRequestObject": { + "$ref": "./examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies": { + "get": { + "tags": [ + "DppResourceGuardProxies" + ], + "summary": "Returns the list of ResourceGuardProxies associated with the vault", + "operationId": "DppResourceGuardProxy_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardProxyBaseResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get ResourceGuardProxies": { + "$ref": "./examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}": { + "get": { + "tags": [ + "DppResourceGuardProxies" + ], + "summary": "Returns the ResourceGuardProxy object associated with the vault, and that matches the name in the request", + "operationId": "DppResourceGuardProxy_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "resourceGuardProxyName", + "description": "name of the resource guard proxy", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]*$" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardProxyBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ResourceGuardProxy": { + "$ref": "./examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json" + } + } + }, + "put": { + "tags": [ + "DppResourceGuardProxies" + ], + "summary": "Creates or Updates a ResourceGuardProxy", + "operationId": "DppResourceGuardProxy_CreateOrUpdate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "resourceGuardProxyName", + "description": "name of the resource guard proxy", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]*$" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGuardProxyBaseResource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ResourceGuardProxyBaseResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create ResourceGuardProxy": { + "$ref": "./examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json" + } + } + }, + "delete": { + "tags": [ + "DppResourceGuardProxies" + ], + "summary": "Deletes the ResourceGuardProxy", + "operationId": "DppResourceGuardProxy_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "resourceGuardProxyName", + "description": "name of the resource guard proxy", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]*$" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete ResourceGuardProxy": { + "$ref": "./examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataProtection/backupVaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}/unlockDelete": { + "post": { + "tags": [ + "DppResourceGuardProxies" + ], + "summary": "UnlockDelete call for ResourceGuardProxy, executed before one can delete it", + "operationId": "DppResourceGuardProxy_UnlockDelete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/VaultName" + }, + { + "name": "resourceGuardProxyName", + "description": "name of the resource guard proxy", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]*$" + }, + { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "Request body for operation", + "required": true, + "schema": { + "$ref": "#/definitions/UnlockDeleteRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UnlockDeleteResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UnlockDelete ResourceGuardProxy": { + "$ref": "./examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json" + } + } + } + } + }, + "definitions": { + "AbsoluteDeleteOption": { + "allOf": [ + { + "$ref": "#/definitions/DeleteOption" + } + ], + "description": "Delete option with duration", + "required": [ + "duration", + "objectType" + ], + "title": "AbsoluteDeleteOption", + "type": "object", + "x-ms-discriminator-value": "AbsoluteDeleteOption" + }, + "RecoveryPointsFilters": { + "type": "object", + "properties": { + "restorePointDataStoreId": { + "type": "string" + }, + "isVisible": { + "type": "boolean" + }, + "startDate": { + "type": "string" + }, + "endDate": { + "type": "string" + }, + "extendedInfo": { + "type": "boolean" + }, + "restorePointState": { + "type": "string" + } + } + }, + "AdHocBackupRuleOptions": { + "description": "Adhoc backup rules", + "properties": { + "ruleName": { + "type": "string" + }, + "triggerOption": { + "$ref": "#/definitions/AdhocBackupTriggerOption" + } + }, + "required": [ + "ruleName", + "triggerOption" + ], + "title": "AdHocBackupRuleOptions", + "type": "object" + }, + "AdhocBackupTriggerOption": { + "description": "Adhoc backup trigger option", + "properties": { + "retentionTagOverride": { + "type": "string" + } + }, + "title": "AdhocBackupTriggerOption", + "type": "object" + }, + "AdhocBasedTaggingCriteria": { + "description": "Adhoc backup tagging criteria", + "properties": { + "tagInfo": { + "$ref": "#/definitions/RetentionTag", + "description": "Retention tag information" + } + }, + "title": "AdhocBasedTaggingCriteria", + "type": "object" + }, + "AdhocBasedTriggerContext": { + "allOf": [ + { + "$ref": "#/definitions/TriggerContext" + } + ], + "description": "Adhoc trigger context", + "properties": { + "taggingCriteria": { + "$ref": "#/definitions/AdhocBasedTaggingCriteria", + "description": "Tagging Criteria containing retention tag for adhoc backup." + } + }, + "required": [ + "objectType", + "taggingCriteria" + ], + "title": "AdhocBasedTriggerContext", + "type": "object", + "x-ms-discriminator-value": "AdhocBasedTriggerContext" + }, + "AuthCredentials": { + "description": "Base class for different types of authentication credentials.", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + } + }, + "discriminator": "objectType" + }, + "AzureBackupDiscreteRecoveryPoint": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRecoveryPoint" + } + ], + "description": "Azure backup discrete RecoveryPoint", + "properties": { + "friendlyName": { + "type": "string" + }, + "recoveryPointDataStoresDetails": { + "items": { + "$ref": "#/definitions/RecoveryPointDataStoreDetails" + }, + "type": "array" + }, + "recoveryPointTime": { + "format": "date-time", + "type": "string" + }, + "policyName": { + "type": "string" + }, + "policyVersion": { + "type": "string" + }, + "recoveryPointId": { + "type": "string" + }, + "recoveryPointType": { + "type": "string" + }, + "retentionTagName": { + "type": "string" + }, + "retentionTagVersion": { + "type": "string" + }, + "expiryTime": { + "format": "date-time", + "type": "string", + "readOnly": true + } + }, + "required": [ + "recoveryPointTime" + ], + "title": "AzureBackupDiscreteRecoveryPoint", + "type": "object", + "x-ms-discriminator-value": "AzureBackupDiscreteRecoveryPoint" + }, + "AzureBackupFindRestorableTimeRangesRequest": { + "description": "List Restore Ranges Request", + "required": [ + "sourceDataStoreType" + ], + "type": "object", + "properties": { + "sourceDataStoreType": { + "description": "Gets or sets the type of the source data store.", + "enum": [ + "OperationalStore", + "VaultStore", + "ArchiveStore" + ], + "type": "string", + "x-ms-enum": { + "name": "RestoreSourceDataStoreType", + "modelAsString": true + } + }, + "startTime": { + "description": "Start time for the List Restore Ranges request. ISO 8601 format.", + "type": "string" + }, + "endTime": { + "description": "End time for the List Restore Ranges request. ISO 8601 format.", + "type": "string" + } + } + }, + "AzureBackupFindRestorableTimeRangesRequestResource": { + "description": "List Restore Ranges Request", + "allOf": [ + { + "$ref": "#/definitions/DppWorkerRequest" + } + ], + "properties": { + "content": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesRequest", + "description": "AzureBackupFindRestorableTimeRangesRequestResource content" + } + } + }, + "AzureBackupFindRestorableTimeRangesResponse": { + "description": "List Restore Ranges Response", + "type": "object", + "properties": { + "restorableTimeRanges": { + "description": "Returns the Restore Ranges available on the Backup Instance.", + "type": "array", + "items": { + "$ref": "#/definitions/RestorableTimeRange" + }, + "x-ms-identifiers": [] + }, + "objectType": { + "type": "string" + } + } + }, + "AzureBackupFindRestorableTimeRangesResponseResource": { + "description": "List Restore Ranges Response", + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureBackupFindRestorableTimeRangesResponse", + "description": "AzureBackupFindRestorableTimeRangesResponseResource properties" + } + } + }, + "AzureBackupJob": { + "description": "AzureBackup Job Class", + "properties": { + "activityID": { + "description": "Job Activity Id", + "type": "string" + }, + "backupInstanceFriendlyName": { + "description": "Name of the Backup Instance", + "type": "string" + }, + "backupInstanceId": { + "description": "ARM ID of the Backup Instance", + "readOnly": true, + "type": "string" + }, + "dataSourceId": { + "description": "ARM ID of the DataSource", + "type": "string" + }, + "dataSourceLocation": { + "description": "Location of the DataSource", + "type": "string" + }, + "dataSourceName": { + "description": "User Friendly Name of the DataSource", + "type": "string" + }, + "dataSourceSetName": { + "description": "Data Source Set Name of the DataSource", + "type": "string" + }, + "dataSourceType": { + "description": "Type of DataSource", + "type": "string" + }, + "duration": { + "description": "Total run time of the job. ISO 8601 format.", + "type": "string" + }, + "endTime": { + "description": "EndTime of the job(in UTC)", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errorDetails": { + "description": "A List, detailing the errors related to the job", + "items": { + "$ref": "#/definitions/UserFacingError" + }, + "x-ms-identifiers": [], + "readOnly": true, + "type": "array" + }, + "extendedInfo": { + "$ref": "#/definitions/JobExtendedInfo", + "description": "Extended Information about the job", + "readOnly": true + }, + "isUserTriggered": { + "description": "Indicated that whether the job is adhoc(true) or scheduled(false)", + "type": "boolean" + }, + "operation": { + "description": "It indicates the type of Job i.e. Backup:full/log/diff ;Restore:ALR/OLR; Tiering:Backup/Archive ; Management:ConfigureProtection/UnConfigure", + "type": "string" + }, + "operationCategory": { + "description": "It indicates the type of Job i.e. Backup/Restore/Tiering/Management", + "type": "string" + }, + "policyId": { + "description": "ARM ID of the policy", + "readOnly": true, + "type": "string" + }, + "policyName": { + "description": "Name of the policy", + "readOnly": true, + "type": "string" + }, + "progressEnabled": { + "description": "Indicated whether progress is enabled for the job", + "type": "boolean" + }, + "progressUrl": { + "description": "Url which contains job's progress", + "readOnly": true, + "type": "string" + }, + "restoreType": { + "description": "It indicates the sub type of operation i.e. in case of Restore it can be ALR/OLR", + "readOnly": true, + "type": "string" + }, + "sourceResourceGroup": { + "description": "Resource Group Name of the Datasource", + "type": "string" + }, + "sourceSubscriptionID": { + "description": "SubscriptionId corresponding to the DataSource", + "type": "string" + }, + "startTime": { + "description": "StartTime of the job(in UTC)", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "Status of the job like InProgress/Success/Failed/Cancelled/SuccessWithWarning", + "type": "string" + }, + "subscriptionId": { + "description": "Subscription Id of the corresponding backup vault", + "type": "string" + }, + "supportedActions": { + "description": "List of supported actions", + "items": { + "type": "string" + }, + "type": "array" + }, + "vaultName": { + "description": "Name of the vault", + "type": "string" + }, + "etag": { + "type": "string" + }, + "sourceDataStoreName": { + "type": "string" + }, + "destinationDataStoreName": { + "type": "string" + } + }, + "required": [ + "activityID", + "subscriptionId", + "dataSourceId", + "vaultName", + "backupInstanceFriendlyName", + "sourceResourceGroup", + "dataSourceName", + "progressEnabled", + "sourceSubscriptionID", + "dataSourceLocation", + "startTime", + "dataSourceType", + "operationCategory", + "operation", + "status", + "isUserTriggered", + "supportedActions" + ], + "type": "object" + }, + "CrossRegionRestoreJobRequest": { + "required": [ + "sourceRegion", + "sourceBackupVaultId", + "jobId" + ], + "type": "object", + "properties": { + "sourceRegion": { + "type": "string" + }, + "sourceBackupVaultId": { + "type": "string" + }, + "jobId": { + "type": "string" + } + } + }, + "CrossRegionRestoreJobsRequest": { + "required": [ + "sourceRegion", + "sourceBackupVaultId" + ], + "type": "object", + "properties": { + "sourceRegion": { + "type": "string" + }, + "sourceBackupVaultId": { + "type": "string" + } + } + }, + "AzureBackupJobResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "AzureBackup Job Resource Class", + "properties": { + "properties": { + "$ref": "#/definitions/AzureBackupJob", + "description": "AzureBackupJobResource properties", + "type": "object" + } + }, + "type": "object" + }, + "AzureBackupJobResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "List of AzureBackup Job resources", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/AzureBackupJobResource" + }, + "type": "array" + } + }, + "type": "object" + }, + "AzureBackupParams": { + "allOf": [ + { + "$ref": "#/definitions/BackupParameters" + } + ], + "description": "Azure backup parameters", + "properties": { + "backupType": { + "description": "BackupType ; Full/Incremental etc", + "type": "string" + } + }, + "required": [ + "backupType", + "objectType" + ], + "title": "AzureBackupParams", + "type": "object", + "x-ms-discriminator-value": "AzureBackupParams" + }, + "AzureBackupRecoveryPoint": { + "description": "Azure backup recoveryPoint", + "discriminator": "objectType", + "properties": { + "objectType": { + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "AzureBackupRecoveryPoint", + "type": "object" + }, + "AzureBackupRecoveryPointBasedRestoreRequest": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRestoreRequest" + } + ], + "description": "Azure backup recoveryPoint based restore request", + "properties": { + "recoveryPointId": { + "type": "string" + } + }, + "required": [ + "recoveryPointId" + ], + "title": "AzureBackupRecoveryPointBasedRestoreRequest", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRecoveryPointBasedRestoreRequest" + }, + "AzureBackupRecoveryPointResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "Azure backup recoveryPoint resource", + "properties": { + "properties": { + "$ref": "#/definitions/AzureBackupRecoveryPoint", + "description": "AzureBackupRecoveryPointResource properties" + } + }, + "title": "AzureBackupRecoveryPointResource" + }, + "AzureBackupRecoveryPointResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "Azure backup recoveryPoint resource list", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/AzureBackupRecoveryPointResource" + }, + "type": "array" + } + }, + "title": "AzureBackupRecoveryPointResourceList", + "type": "object" + }, + "AzureBackupRehydrationRequest": { + "description": "Azure Backup Rehydrate Request", + "properties": { + "recoveryPointId": { + "description": "Id of the recovery point to be recovered", + "type": "string" + }, + "rehydrationPriority": { + "description": "Priority to be used for rehydration. Values High or Standard", + "$ref": "#/definitions/RehydrationPriority" + }, + "rehydrationRetentionDuration": { + "description": "Retention duration in ISO 8601 format i.e P10D .", + "type": "string" + } + }, + "required": [ + "recoveryPointId", + "rehydrationRetentionDuration" + ], + "title": "AzureBackupRehydrationRequest", + "type": "object" + }, + "AzureBackupRestoreRequest": { + "description": "Azure backup restore request", + "discriminator": "objectType", + "properties": { + "objectType": { + "type": "string" + }, + "restoreTargetInfo": { + "$ref": "#/definitions/RestoreTargetInfoBase", + "description": "Gets or sets the restore target information." + }, + "sourceDataStoreType": { + "description": "Gets or sets the type of the source data store.", + "enum": [ + "ArchiveStore", + "SnapshotStore", + "OperationalStore", + "VaultStore" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SourceDataStoreType" + } + }, + "sourceResourceId": { + "description": "Fully qualified Azure Resource Manager ID of the datasource which is being recovered.", + "type": "string" + }, + "identityDetails": { + "$ref": "#/definitions/IdentityDetails", + "description": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned." + } + }, + "required": [ + "objectType", + "restoreTargetInfo", + "sourceDataStoreType" + ], + "title": "AzureBackupRestoreRequest", + "type": "object" + }, + "IdentityDetails": { + "type": "object", + "properties": { + "useSystemAssignedIdentity": { + "description": "Specifies if the BI is protected by System Identity.", + "type": "boolean" + }, + "userAssignedIdentityArmUrl": { + "description": "ARM URL for User Assigned Identity.", + "type": "string" + } + } + }, + "AzureBackupRestoreWithRehydrationRequest": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRecoveryPointBasedRestoreRequest" + } + ], + "description": "AzureBackup Restore with Rehydration Request", + "properties": { + "rehydrationPriority": { + "description": "Priority to be used for rehydration. Values High or Standard", + "$ref": "#/definitions/RehydrationPriority" + }, + "rehydrationRetentionDuration": { + "description": "Retention duration in ISO 8601 format i.e P10D .", + "type": "string" + } + }, + "required": [ + "rehydrationPriority", + "rehydrationRetentionDuration" + ], + "title": "AzureBackupRestoreWithRehydrationRequest", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRestoreWithRehydrationRequest" + }, + "AzureBackupRecoveryTimeBasedRestoreRequest": { + "allOf": [ + { + "$ref": "#/definitions/AzureBackupRestoreRequest" + } + ], + "description": "AzureBackup RecoveryPointTime Based Restore Request", + "properties": { + "recoveryPointTime": { + "description": "The recovery time in ISO 8601 format example - 2020-08-14T17:30:00.0000000Z.", + "type": "string" + } + }, + "required": [ + "recoveryPointTime" + ], + "title": "AzureBackupRecoveryTimeBasedRestoreRequest", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRecoveryTimeBasedRestoreRequest" + }, + "AzureBackupRule": { + "allOf": [ + { + "$ref": "#/definitions/BasePolicyRule" + } + ], + "description": "Azure backup rule", + "properties": { + "backupParameters": { + "$ref": "#/definitions/BackupParameters" + }, + "dataStore": { + "$ref": "#/definitions/DataStoreInfoBase" + }, + "trigger": { + "$ref": "#/definitions/TriggerContext" + } + }, + "required": [ + "dataStore", + "name", + "objectType", + "trigger" + ], + "title": "AzureBackupRule", + "type": "object", + "x-ms-discriminator-value": "AzureBackupRule" + }, + "AzureMonitorAlertSettings": { + "type": "object", + "description": "Settings for Azure Monitor based alerts", + "properties": { + "alertsForAllJobFailures": { + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "AlertsState", + "modelAsString": true + } + } + } + }, + "AzureOperationalStoreParameters": { + "description": "Parameters for Operational-Tier DataStore", + "required": [ + "objectType", + "dataStoreType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DataStoreParameters" + } + ], + "properties": { + "resourceGroupId": { + "description": "Gets or sets the Snapshot Resource Group Uri.", + "type": "string" + } + }, + "x-ms-discriminator-value": "AzureOperationalStoreParameters" + }, + "KubernetesClusterBackupDatasourceParameters": { + "description": "Parameters for Kubernetes Cluster Backup Datasource", + "required": [ + "snapshotVolumes", + "includeClusterScopeResources" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupDatasourceParameters" + } + ], + "properties": { + "snapshotVolumes": { + "description": "Gets or sets the volume snapshot property. This property if enabled will take volume snapshots during restore.", + "type": "boolean" + }, + "includeClusterScopeResources": { + "description": "Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore.", + "type": "boolean" + }, + "includedNamespaces": { + "description": "Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludedNamespaces": { + "description": "Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedResourceTypes": { + "description": "Gets or sets the include resource types property. This property sets the resource types to be included during restore.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludedResourceTypes": { + "description": "Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.", + "items": { + "type": "string" + }, + "type": "array" + }, + "labelSelectors": { + "description": "Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "x-ms-discriminator-value": "KubernetesClusterBackupDatasourceParameters" + }, + "BlobBackupDatasourceParameters": { + "description": "Parameters to be used during configuration of backup of blobs", + "required": [ + "containersList", + "objectType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupDatasourceParameters" + } + ], + "properties": { + "containersList": { + "description": "List of containers to be backed up during configuration of backup of blobs", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "BlobBackupDatasourceParameters" + }, + "AzureRetentionRule": { + "allOf": [ + { + "$ref": "#/definitions/BasePolicyRule" + } + ], + "description": "Azure retention rule", + "properties": { + "isDefault": { + "type": "boolean" + }, + "lifecycles": { + "items": { + "$ref": "#/definitions/SourceLifeCycle" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "lifecycles", + "name", + "objectType" + ], + "title": "AzureRetentionRule", + "type": "object", + "x-ms-discriminator-value": "AzureRetentionRule" + }, + "BackupCriteria": { + "description": "BackupCriteria base class", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "BackupCriteria", + "type": "object" + }, + "BackupInstance": { + "description": "Backup Instance", + "required": [ + "dataSourceInfo", + "policyInfo", + "objectType" + ], + "type": "object", + "properties": { + "friendlyName": { + "description": "Gets or sets the Backup Instance friendly name.", + "type": "string" + }, + "dataSourceInfo": { + "$ref": "#/definitions/Datasource", + "description": "Gets or sets the data source information." + }, + "dataSourceSetInfo": { + "$ref": "#/definitions/DatasourceSet", + "description": "Gets or sets the data source set information." + }, + "policyInfo": { + "$ref": "#/definitions/PolicyInfo", + "description": "Gets or sets the policy information." + }, + "protectionStatus": { + "$ref": "#/definitions/ProtectionStatusDetails", + "description": "Specifies the protection status of the resource", + "readOnly": true + }, + "currentProtectionState": { + "description": "Specifies the current protection state of the resource", + "enum": [ + "Invalid", + "NotProtected", + "ConfiguringProtection", + "ProtectionConfigured", + "BackupSchedulesSuspended", + "RetentionSchedulesSuspended", + "ProtectionStopped", + "ProtectionError", + "ConfiguringProtectionFailed", + "SoftDeleting", + "SoftDeleted", + "UpdatingProtection" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "CurrentProtectionState", + "modelAsString": true + } + }, + "protectionErrorDetails": { + "$ref": "#/definitions/UserFacingError", + "description": "Specifies the protection error of the resource", + "readOnly": true + }, + "provisioningState": { + "description": "Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed", + "type": "string", + "readOnly": true + }, + "datasourceAuthCredentials": { + "$ref": "#/definitions/AuthCredentials", + "description": "Credentials to use to authenticate with data source provider." + }, + "validationType": { + "description": "Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again.", + "enum": [ + "ShallowValidation", + "DeepValidation" + ], + "type": "string", + "x-ms-enum": { + "name": "ValidationType", + "modelAsString": true + } + }, + "identityDetails": { + "$ref": "#/definitions/IdentityDetails", + "description": "Contains information of the Identity Details for the BI.\r\nIf it is null, default will be considered as System Assigned." + }, + "objectType": { + "type": "string" + } + } + }, + "BackupInstanceResource": { + "allOf": [ + { + "$ref": "#/definitions/DppProxyResource" + } + ], + "description": "BackupInstance Resource", + "properties": { + "properties": { + "$ref": "#/definitions/BackupInstance", + "description": "BackupInstanceResource properties" + } + }, + "title": "BackupInstanceResource" + }, + "BackupInstanceResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "BackupInstance Resource list response", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/BackupInstanceResource" + }, + "type": "array" + } + }, + "title": "BackupInstanceResourceList", + "type": "object" + }, + "BackupParameters": { + "description": "BackupParameters base", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "BackupParameters", + "type": "object" + }, + "BackupPolicy": { + "allOf": [ + { + "$ref": "#/definitions/BaseBackupPolicy" + } + ], + "description": "Rule based backup policy", + "properties": { + "policyRules": { + "description": "Policy rule dictionary that contains rules for each backuptype i.e Full/Incremental/Logs etc", + "items": { + "$ref": "#/definitions/BasePolicyRule" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "datasourceTypes", + "policyRules" + ], + "title": "BackupPolicy", + "type": "object", + "x-ms-discriminator-value": "BackupPolicy" + }, + "BackupSchedule": { + "description": "Schedule for backup", + "properties": { + "repeatingTimeIntervals": { + "description": "ISO 8601 repeating time interval format", + "items": { + "type": "string" + }, + "type": "array" + }, + "timeZone": { + "description": "Time zone for a schedule. Example: Pacific Standard Time", + "type": "string" + } + }, + "required": [ + "repeatingTimeIntervals" + ], + "title": "BackupSchedule", + "type": "object" + }, + "BackupVault": { + "description": "Backup Vault", + "properties": { + "monitoringSettings": { + "$ref": "#/definitions/MonitoringSettings", + "description": "Monitoring Settings" + }, + "provisioningState": { + "description": "Provisioning state of the BackupVault resource", + "enum": [ + "Failed", + "Provisioning", + "Succeeded", + "Unknown", + "Updating" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ProvisioningState" + } + }, + "resourceMoveState": { + "description": "Resource move state for backup vault", + "enum": [ + "Unknown", + "InProgress", + "PrepareFailed", + "CommitFailed", + "Failed", + "PrepareTimedout", + "CommitTimedout", + "CriticalFailure", + "PartialSuccess", + "MoveSucceeded" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ResourceMoveState", + "modelAsString": true + } + }, + "resourceMoveDetails": { + "$ref": "#/definitions/ResourceMoveDetails", + "description": "Resource move details for backup vault", + "readOnly": true + }, + "securitySettings": { + "$ref": "#/definitions/SecuritySettings", + "description": "Security Settings" + }, + "storageSettings": { + "description": "Storage Settings", + "items": { + "$ref": "#/definitions/StorageSetting" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "isVaultProtectedByResourceGuard": { + "description": "Is vault protected by resource guard", + "type": "boolean", + "readOnly": true + }, + "featureSettings": { + "$ref": "#/definitions/FeatureSettings", + "description": "Feature Settings" + }, + "secureScore": { + "description": "Secure Score of Backup Vault", + "enum": [ + "None", + "Minimum", + "Adequate", + "Maximum", + "NotSupported" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SecureScoreLevel", + "modelAsString": true + } + } + }, + "required": [ + "storageSettings" + ], + "title": "BackupVault", + "type": "object" + }, + "BackupVaultResource": { + "allOf": [ + { + "$ref": "#/definitions/DppTrackedResource" + } + ], + "description": "Backup Vault Resource", + "properties": { + "properties": { + "$ref": "#/definitions/BackupVault", + "description": "BackupVaultResource properties" + } + }, + "required": [ + "location", + "properties" + ], + "title": "BackupVault Resource" + }, + "BackupVaultResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "List of BackupVault resources", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/BackupVaultResource" + }, + "type": "array" + } + }, + "title": "BackupVaultResourceList", + "type": "object" + }, + "BaseBackupPolicy": { + "description": "BackupPolicy base", + "discriminator": "objectType", + "properties": { + "datasourceTypes": { + "description": "Type of datasource for the backup management", + "items": { + "type": "string" + }, + "type": "array" + }, + "objectType": { + "type": "string" + } + }, + "required": [ + "datasourceTypes", + "objectType" + ], + "title": "BaseBackupPolicy", + "type": "object" + }, + "BaseBackupPolicyResource": { + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "description": "BaseBackupPolicy resource", + "properties": { + "properties": { + "$ref": "#/definitions/BaseBackupPolicy", + "description": "BaseBackupPolicyResource properties" + } + }, + "title": "BaseBackupPolicyResource" + }, + "BaseBackupPolicyResourceList": { + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "description": "List of BaseBackupPolicy resources", + "properties": { + "value": { + "description": "List of resources.", + "items": { + "$ref": "#/definitions/BaseBackupPolicyResource" + }, + "type": "array" + } + }, + "title": "BaseBackupPolicyResourceList", + "type": "object" + }, + "BasePolicyRule": { + "description": "BasePolicy Rule", + "discriminator": "objectType", + "properties": { + "name": { + "type": "string" + }, + "objectType": { + "type": "string" + } + }, + "required": [ + "name", + "objectType" + ], + "title": "BasePolicyRule", + "type": "object" + }, + "CheckNameAvailabilityRequest": { + "description": "CheckNameAvailability Request", + "properties": { + "name": { + "description": "Resource name for which availability needs to be checked", + "type": "string" + }, + "type": { + "description": "Describes the Resource type: Microsoft.DataProtection/BackupVaults", + "type": "string" + } + }, + "title": "CheckNameAvailabilityRequest", + "type": "object" + }, + "CheckNameAvailabilityResult": { + "description": "CheckNameAvailability Result", + "properties": { + "message": { + "description": "Gets or sets the message.", + "type": "string" + }, + "nameAvailable": { + "description": "Gets or sets a value indicating whether [name available].", + "type": "boolean" + }, + "reason": { + "description": "Gets or sets the reason.", + "type": "string" + } + }, + "title": "CheckNameAvailabilityResult", + "type": "object" + }, + "ClientDiscoveryDisplay": { + "description": "Localized display information of an operation.", + "properties": { + "description": { + "description": "Description of the operation having details of what operation is about.", + "type": "string" + }, + "operation": { + "description": "Operations Name itself.", + "type": "string" + }, + "provider": { + "description": "Name of the provider for display purposes", + "type": "string" + }, + "resource": { + "description": "ResourceType for which this Operation can be performed.", + "type": "string" + } + }, + "title": "ClientDiscoveryDisplay", + "type": "object" + }, + "ClientDiscoveryForLogSpecification": { + "description": "Class to represent shoebox log specification in json client discovery.", + "properties": { + "blobDuration": { + "description": "blob duration of shoebox log specification", + "type": "string" + }, + "displayName": { + "description": "Localized display name", + "type": "string" + }, + "name": { + "description": "Name for shoebox log specification.", + "type": "string" + } + }, + "title": "ClientDiscoveryForLogSpecification", + "type": "object" + }, + "ClientDiscoveryForProperties": { + "description": "Class to represent shoebox properties in json client discovery.", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ClientDiscoveryForServiceSpecification", + "description": "Operation properties." + } + }, + "title": "ClientDiscoveryForProperties", + "type": "object" + }, + "ClientDiscoveryForServiceSpecification": { + "description": "Class to represent shoebox service specification in json client discovery.", + "properties": { + "logSpecifications": { + "description": "List of log specifications of this operation.", + "items": { + "$ref": "#/definitions/ClientDiscoveryForLogSpecification" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "title": "ClientDiscoveryForServiceSpecification", + "type": "object" + }, + "ClientDiscoveryResponse": { + "description": "Operations List response which contains list of available APIs.", + "properties": { + "nextLink": { + "description": "Link to the next chunk of Response.", + "type": "string" + }, + "value": { + "description": "List of available operations.", + "items": { + "$ref": "#/definitions/ClientDiscoveryValueForSingleApi" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "title": "ClientDiscoveryResponse", + "type": "object" + }, + "ClientDiscoveryValueForSingleApi": { + "description": "Available operation details.", + "properties": { + "display": { + "$ref": "#/definitions/ClientDiscoveryDisplay", + "description": "Contains the localized display information for this particular operation" + }, + "name": { + "description": "Name of the Operation.", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + }, + "origin": { + "description": "The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/ClientDiscoveryForProperties", + "description": "Properties for the given operation." + } + }, + "title": "ClientDiscoveryValueForSingleApi", + "type": "object" + }, + "FetchSecondaryRPsRequestParameters": { + "description": "Information about BI whose secondary RecoveryPoints are requested\r\nSource region and\r\nBI ARM path", + "type": "object", + "properties": { + "sourceRegion": { + "description": "Source region in which BackupInstance is located", + "type": "string" + }, + "sourceBackupInstanceId": { + "description": "ARM Path of BackupInstance", + "type": "string" + } + } + }, + "CloudError": { + "description": "An error response from Azure Backup.", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + }, + "title": "CloudError", + "x-ms-external": true + }, + "CopyOnExpiryOption": { + "allOf": [ + { + "$ref": "#/definitions/CopyOption" + } + ], + "description": "Copy on Expiry Option", + "required": [ + "objectType" + ], + "title": "CopyOnExpiryOption", + "type": "object", + "x-ms-discriminator-value": "CopyOnExpiryOption" + }, + "CopyOption": { + "description": "Options to copy", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "CopyOption", + "type": "object" + }, + "CrossRegionRestoreSettings": { + "type": "object", + "properties": { + "state": { + "description": "CrossRegionRestore state", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "CrossRegionRestoreState", + "modelAsString": true + } + } + } + }, + "CrossSubscriptionRestoreSettings": { + "description": "CrossSubscriptionRestore Settings", + "type": "object", + "properties": { + "state": { + "description": "CrossSubscriptionRestore state", + "enum": [ + "Disabled", + "PermanentlyDisabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "CrossSubscriptionRestoreState", + "modelAsString": true + } + } + } + }, + "CustomCopyOption": { + "allOf": [ + { + "$ref": "#/definitions/CopyOption" + } + ], + "description": "Duration based custom options to copy", + "properties": { + "duration": { + "description": "Data copied after given timespan", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "CustomCopyOption", + "type": "object", + "x-ms-discriminator-value": "CustomCopyOption" + }, + "Datasource": { + "description": "Datasource to be backed up", + "properties": { + "datasourceType": { + "description": "DatasourceType of the resource.", + "type": "string" + }, + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "type": "string" + }, + "resourceID": { + "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.", + "type": "string" + }, + "resourceLocation": { + "description": "Location of datasource.", + "type": "string" + }, + "resourceName": { + "description": "Unique identifier of the resource in the context of parent.", + "type": "string" + }, + "resourceType": { + "description": "Resource Type of Datasource.", + "type": "string" + }, + "resourceUri": { + "description": "Uri of the resource.", + "type": "string" + } + }, + "required": [ + "resourceID" + ], + "title": "Datasource", + "type": "object" + }, + "DatasourceSet": { + "description": "DatasourceSet details of datasource to be backed up", + "properties": { + "datasourceType": { + "description": "DatasourceType of the resource.", + "type": "string" + }, + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "type": "string" + }, + "resourceID": { + "description": "Full ARM ID of the resource. For azure resources, this is ARM ID. For non azure resources, this will be the ID created by backup service via Fabric/Vault.", + "type": "string" + }, + "resourceLocation": { + "description": "Location of datasource.", + "type": "string" + }, + "resourceName": { + "description": "Unique identifier of the resource in the context of parent.", + "type": "string" + }, + "resourceType": { + "description": "Resource Type of Datasource.", + "type": "string" + }, + "resourceUri": { + "description": "Uri of the resource.", + "type": "string" + } + }, + "required": [ + "resourceID" + ], + "title": "DatasourceSet", + "type": "object" + }, + "DataStoreInfoBase": { + "description": "DataStoreInfo base", + "properties": { + "dataStoreType": { + "description": "type of datastore; Operational/Vault/Archive", + "enum": [ + "OperationalStore", + "VaultStore", + "ArchiveStore" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataStoreTypes" + } + }, + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "readOnly": false, + "type": "string" + } + }, + "required": [ + "dataStoreType", + "objectType" + ], + "title": "DataStoreInfoBase", + "type": "object" + }, + "DataStoreParameters": { + "description": "Parameters for DataStore", + "required": [ + "objectType", + "dataStoreType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + }, + "dataStoreType": { + "description": "type of datastore; Operational/Vault/Archive", + "enum": [ + "OperationalStore", + "VaultStore", + "ArchiveStore" + ], + "type": "string", + "x-ms-enum": { + "name": "DataStoreTypes", + "modelAsString": true + } + } + }, + "discriminator": "objectType" + }, + "BackupDatasourceParameters": { + "description": "Parameters for Backup Datasource", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + } + }, + "discriminator": "objectType" + }, + "Day": { + "description": "Day of the week", + "properties": { + "date": { + "description": "Date of the month", + "format": "int32", + "type": "integer" + }, + "isLast": { + "description": "Whether Date is last date of month", + "type": "boolean" + } + }, + "title": "Day", + "type": "object" + }, + "DeletedBackupInstance": { + "description": "Deleted Backup Instance", + "required": [ + "dataSourceInfo", + "policyInfo" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupInstance" + } + ], + "properties": { + "deletionInfo": { + "$ref": "#/definitions/DeletionInfo", + "description": "Deletion info of Backup Instance", + "readOnly": true + } + } + }, + "DeletedBackupInstanceResource": { + "description": "Deleted Backup Instance", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DeletedBackupInstance", + "description": "DeletedBackupInstanceResource properties" + } + } + }, + "DeletedBackupInstanceResourceList": { + "description": "List of DeletedBackupInstance resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DeletedBackupInstanceResource" + } + } + } + }, + "DeletionInfo": { + "description": "Deletion Info", + "type": "object", + "properties": { + "deletionTime": { + "description": "Specifies time of deletion", + "type": "string", + "readOnly": true + }, + "billingEndDate": { + "description": "Specifies billing end date", + "type": "string", + "readOnly": true + }, + "scheduledPurgeTime": { + "description": "Specifies purge time", + "type": "string", + "readOnly": true + }, + "deleteActivityID": { + "description": "Delete activity ID for troubleshooting purpose", + "type": "string", + "readOnly": true + } + } + }, + "DeleteOption": { + "description": "Delete Option", + "discriminator": "objectType", + "properties": { + "duration": { + "description": "Duration of deletion after given timespan", + "type": "string" + }, + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "duration", + "objectType" + ], + "title": "DeleteOption", + "type": "object" + }, + "DppIdentityDetails": { + "description": "Identity details", + "properties": { + "principalId": { + "description": "The object ID of the service principal object for the managed identity that is used to grant role-based access to an Azure resource.", + "readOnly": true, + "type": "string" + }, + "tenantId": { + "description": "A Globally Unique Identifier (GUID) that represents the Azure AD tenant where the resource is now a member.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None", + "type": "string" + }, + "userAssignedIdentities": { + "description": "Gets or sets the user assigned identities.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentityDetails" + } + } + }, + "title": "DppIdentityDetails", + "type": "object" + }, + "UserAssignedIdentityDetails": { + "description": "User Assigned Identity Details", + "type": "object", + "properties": { + "clientId": { + "description": "The Client Id of the User Assigned Managed Identity.", + "type": "string", + "readOnly": true + }, + "principalId": { + "description": "The Object Id of the User Assigned Managed Identity.", + "type": "string", + "readOnly": true + } + } + }, + "DppBaseResourceList": { + "description": "Base for all lists of V2 resources.", + "type": "object", + "properties": { + "value": { + "description": "List of Dpp resources.", + "type": "array", + "items": { + "$ref": "#/definitions/DppBaseResource" + } + }, + "nextLink": { + "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.", + "type": "string" + } + } + }, + "DppBaseResource": { + "type": "object", + "description": "Base resource under Microsoft.DataProtection provider namespace", + "properties": { + "id": { + "description": "Resource Id represents the complete path to the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name associated with the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "type": "string", + "readOnly": true + } + } + }, + "DppResource": { + "description": "Resource class", + "properties": { + "id": { + "description": "Resource Id represents the complete path to the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name associated with the resource.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "readOnly": true, + "type": "string" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/systemData" + } + }, + "title": "DppResource", + "type": "object", + "x-ms-azure-resource": true + }, + "DppResourceList": { + "description": "ListResource", + "properties": { + "nextLink": { + "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.", + "type": "string" + } + }, + "title": "List Resource", + "type": "object" + }, + "DppBaseTrackedResource": { + "properties": { + "eTag": { + "description": "Optional ETag.", + "type": "string" + }, + "id": { + "description": "Resource Id represents the complete path to the resource.", + "readOnly": true, + "type": "string" + }, + "location": { + "description": "Resource location.", + "type": "string" + }, + "name": { + "description": "Resource name associated with the resource.", + "readOnly": true, + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags.", + "type": "object" + }, + "type": { + "description": "Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "readOnly": true, + "type": "string" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/systemData" + } + }, + "type": "object", + "x-ms-azure-resource": true + }, + "DppTrackedResource": { + "allOf": [ + { + "$ref": "#/definitions/DppBaseTrackedResource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/DppIdentityDetails", + "description": "Input Managed Identity Details" + } + }, + "type": "object", + "x-ms-azure-resource": true + }, + "ImmutabilitySettings": { + "description": "Immutability Settings at vault level", + "type": "object", + "properties": { + "state": { + "description": "Immutability state", + "enum": [ + "Disabled", + "Unlocked", + "Locked" + ], + "type": "string", + "x-ms-enum": { + "name": "ImmutabilityState", + "modelAsString": true + } + } + } + }, + "DppProxyResource": { + "properties": { + "id": { + "description": "Proxy Resource Id represents the complete path to the resource.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Proxy Resource name associated with the resource.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...", + "readOnly": true, + "type": "string" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Proxy Resource tags.", + "type": "object" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v4/types.json#/definitions/systemData" + } + }, + "type": "object", + "x-ms-azure-resource": true + }, + "DppTrackedResourceList": { + "properties": { + "nextLink": { + "description": "The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.", + "type": "string" + } + }, + "type": "object" + }, + "DppWorkerRequest": { + "type": "object", + "properties": { + "subscriptionId": { + "type": "string" + }, + "uri": { + "type": "string" + }, + "headers": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "supportedGroupVersions": { + "type": "array", + "items": { + "type": "string" + } + }, + "cultureInfo": { + "type": "string" + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "httpMethod": { + "type": "string" + } + } + }, + "Error": { + "description": "The resource management error response.", + "properties": { + "additionalInfo": { + "description": "The error additional info.", + "items": { + "$ref": "#/definitions/ErrorAdditionalInfo" + }, + "x-ms-identifiers": [], + "readOnly": true, + "type": "array" + }, + "code": { + "description": "The error code.", + "readOnly": true, + "type": "string" + }, + "details": { + "description": "The error details.", + "items": { + "$ref": "#/definitions/Error" + }, + "x-ms-identifiers": [], + "readOnly": true, + "type": "array" + }, + "message": { + "description": "The error message.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "The error target.", + "readOnly": true, + "type": "string" + } + } + }, + "ErrorAdditionalInfo": { + "description": "The resource management error additional info.", + "properties": { + "info": { + "description": "The additional info.", + "readOnly": true, + "type": "object" + }, + "type": { + "description": "The additional info type.", + "readOnly": true, + "type": "string" + } + } + }, + "ExportJobsResult": { + "description": "The result for export jobs containing blob details.", + "properties": { + "blobUrl": { + "description": "URL of the blob into which the serialized string of list of jobs is exported.", + "readOnly": true, + "type": "string" + }, + "blobSasKey": { + "description": "SAS key to access the blob.", + "readOnly": true, + "type": "string" + }, + "excelFileBlobUrl": { + "description": "URL of the blob into which the ExcelFile is uploaded.", + "readOnly": true, + "type": "string" + }, + "excelFileBlobSasKey": { + "description": "SAS key to access the ExcelFile blob.", + "readOnly": true, + "type": "string" + } + }, + "title": "ExportJobsResult", + "type": "object" + }, + "FeatureSettings": { + "description": "Class containing feature settings of vault", + "type": "object", + "properties": { + "crossSubscriptionRestoreSettings": { + "$ref": "#/definitions/CrossSubscriptionRestoreSettings" + }, + "crossRegionRestoreSettings": { + "$ref": "#/definitions/CrossRegionRestoreSettings" + } + } + }, + "FeatureValidationRequest": { + "description": "Base class for feature object", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureValidationRequestBase" + } + ], + "properties": { + "featureType": { + "description": "backup support feature type.", + "enum": [ + "Invalid", + "DataSourceType" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureType", + "modelAsString": true + } + }, + "featureName": { + "description": "backup support feature name.", + "type": "string" + } + }, + "x-ms-discriminator-value": "FeatureValidationRequest" + }, + "FeatureValidationRequestBase": { + "description": "Base class for Backup Feature support", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + } + }, + "discriminator": "objectType" + }, + "FeatureValidationResponse": { + "description": "Feature Validation Response", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FeatureValidationResponseBase" + } + ], + "properties": { + "featureType": { + "description": "backup support feature type.", + "enum": [ + "Invalid", + "DataSourceType" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureType", + "modelAsString": true + } + }, + "features": { + "description": "Response features", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedFeature" + }, + "x-ms-identifiers": [] + } + }, + "x-ms-discriminator-value": "FeatureValidationResponse" + }, + "FeatureValidationResponseBase": { + "description": "Base class for Backup Feature support", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string", + "readOnly": false + } + }, + "discriminator": "objectType" + }, + "ImmediateCopyOption": { + "allOf": [ + { + "$ref": "#/definitions/CopyOption" + } + ], + "description": "Immediate copy Option", + "required": [ + "objectType" + ], + "title": "ImmediateCopyOption", + "type": "object", + "x-ms-discriminator-value": "ImmediateCopyOption" + }, + "InnerError": { + "description": "Inner Error", + "properties": { + "additionalInfo": { + "additionalProperties": { + "type": "string" + }, + "description": "Any Key value pairs that can be provided to the client for additional verbose information.", + "type": "object" + }, + "code": { + "description": "Unique code for this error", + "type": "string" + }, + "embeddedInnerError": { + "$ref": "#/definitions/InnerError", + "description": "Child Inner Error, to allow Nesting." + } + }, + "title": "InnerError", + "type": "object" + }, + "ItemLevelRestoreCriteria": { + "description": "Class to contain criteria for item level restore", + "required": [ + "objectType" + ], + "type": "object", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "discriminator": "objectType" + }, + "ItemLevelRestoreTargetInfo": { + "description": "Restore target info for Item level restore operation", + "required": [ + "restoreCriteria", + "datasourceInfo", + "recoveryOption" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/RestoreTargetInfoBase" + } + ], + "properties": { + "restoreCriteria": { + "description": "Restore Criteria", + "type": "array", + "items": { + "$ref": "#/definitions/ItemLevelRestoreCriteria" + }, + "x-ms-identifiers": [] + }, + "datasourceInfo": { + "$ref": "#/definitions/Datasource", + "description": "Information of target DS" + }, + "datasourceSetInfo": { + "$ref": "#/definitions/DatasourceSet", + "description": "Information of target DS Set" + }, + "datasourceAuthCredentials": { + "$ref": "#/definitions/AuthCredentials", + "description": "Credentials to use to authenticate with data source provider." + } + }, + "x-ms-discriminator-value": "ItemLevelRestoreTargetInfo" + }, + "ItemPathBasedRestoreCriteria": { + "description": "Prefix criteria to be used to during restore", + "required": [ + "itemPath", + "isPathRelativeToBackupItem", + "objectType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ItemLevelRestoreCriteria" + } + ], + "properties": { + "itemPath": { + "description": "The path of the item to be restored. It could be the full path of the item or the path relative to the backup item", + "type": "string" + }, + "isPathRelativeToBackupItem": { + "description": "Flag to specify if the path is relative to backup item or full path", + "type": "boolean" + }, + "subItemPathPrefix": { + "description": "The list of prefix strings to be used as filter criteria during restore. These are relative to the item path specified.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "ItemPathBasedRestoreCriteria" + }, + "JobExtendedInfo": { + "description": "Extended Information about the job", + "properties": { + "additionalDetails": { + "additionalProperties": { + "readOnly": true, + "type": "string" + }, + "description": "Job's Additional Details" + }, + "backupInstanceState": { + "description": "State of the Backup Instance", + "readOnly": true, + "type": "string" + }, + "dataTransferredInBytes": { + "description": "Number of bytes transferred", + "format": "double", + "readOnly": true, + "type": "number" + }, + "recoveryDestination": { + "description": "Destination where restore is done", + "readOnly": true, + "type": "string" + }, + "sourceRecoverPoint": { + "$ref": "#/definitions/RestoreJobRecoveryPointDetails", + "description": "Details of the Source Recovery Point", + "readOnly": true + }, + "subTasks": { + "description": "List of Sub Tasks of the job", + "items": { + "$ref": "#/definitions/JobSubTask" + }, + "x-ms-identifiers": [], + "readOnly": true, + "type": "array" + }, + "targetRecoverPoint": { + "$ref": "#/definitions/RestoreJobRecoveryPointDetails", + "description": "Details of the Target Recovery Point", + "readOnly": true + } + }, + "type": "object" + }, + "JobSubTask": { + "description": "Details of Job's Sub Task", + "properties": { + "additionalDetails": { + "additionalProperties": { + "readOnly": true, + "type": "string" + }, + "description": "Additional details of Sub Tasks" + }, + "taskId": { + "description": "Task Id of the Sub Task", + "format": "int32", + "type": "integer" + }, + "taskName": { + "description": "Name of the Sub Task", + "type": "string" + }, + "taskProgress": { + "description": "Progress of the Sub Task", + "readOnly": true, + "type": "string" + }, + "taskStatus": { + "description": "Status of the Sub Task", + "type": "string" + } + }, + "required": [ + "taskId", + "taskName", + "taskStatus" + ], + "type": "object" + }, + "MonitoringSettings": { + "type": "object", + "description": "Monitoring Settings", + "properties": { + "azureMonitorAlertSettings": { + "$ref": "#/definitions/AzureMonitorAlertSettings" + } + } + }, + "OperationExtendedInfo": { + "description": "Operation Extended Info", + "properties": { + "objectType": { + "description": "This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.", + "type": "string" + } + }, + "title": "OperationExtendedInfo", + "discriminator": "objectType", + "type": "object", + "required": [ + "objectType" + ] + }, + "CrossRegionRestoreDetails": { + "description": "Cross Region Restore details", + "required": [ + "sourceRegion", + "sourceBackupInstanceId" + ], + "type": "object", + "properties": { + "sourceRegion": { + "type": "string" + }, + "sourceBackupInstanceId": { + "type": "string" + } + } + }, + "ValidateCrossRegionRestoreRequestObject": { + "description": "Cross Region Restore Request Object", + "required": [ + "restoreRequestObject", + "crossRegionRestoreDetails" + ], + "type": "object", + "properties": { + "restoreRequestObject": { + "$ref": "#/definitions/AzureBackupRestoreRequest", + "description": "Gets or sets the restore request object." + }, + "crossRegionRestoreDetails": { + "$ref": "#/definitions/CrossRegionRestoreDetails", + "description": "Cross region restore details." + } + } + }, + "CrossRegionRestoreRequestObject": { + "description": "Cross Region Restore Request Object", + "required": [ + "restoreRequestObject", + "crossRegionRestoreDetails" + ], + "type": "object", + "properties": { + "restoreRequestObject": { + "$ref": "#/definitions/AzureBackupRestoreRequest", + "description": "Gets or sets the restore request object." + }, + "crossRegionRestoreDetails": { + "$ref": "#/definitions/CrossRegionRestoreDetails", + "description": "Cross region restore details." + } + } + }, + "OperationJobExtendedInfo": { + "allOf": [ + { + "$ref": "#/definitions/OperationExtendedInfo" + } + ], + "description": "Operation Job Extended Info", + "properties": { + "jobId": { + "description": "Arm Id of the job created for this operation.", + "type": "string" + } + }, + "title": "OperationJobExtendedInfo", + "type": "object", + "x-ms-discriminator-value": "OperationJobExtendedInfo" + }, + "OperationResource": { + "description": "Operation Resource", + "properties": { + "endTime": { + "description": "End time of the operation", + "format": "date-time", + "type": "string" + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Required if status == failed or status == canceled. This is the OData v4 error format, used by the RPC and will go into the v2.2 Azure REST API guidelines.\r\nThe full set of optional properties (e.g. inner errors / details) can be found in the \"Error Response\" section." + }, + "id": { + "description": "It should match what is used to GET the operation result", + "type": "string" + }, + "name": { + "description": "It must match the last segment of the \"id\" field, and will typically be a GUID / system generated value", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationExtendedInfo", + "description": "End time of the operation" + }, + "startTime": { + "description": "Start time of the operation", + "format": "date-time", + "type": "string" + }, + "status": { + "type": "string" + } + }, + "title": "OperationResource", + "type": "object" + }, + "PatchBackupVaultInput": { + "description": "Backup Vault Contract for Patch Backup Vault API.", + "type": "object", + "properties": { + "monitoringSettings": { + "$ref": "#/definitions/MonitoringSettings", + "description": "Monitoring Settings" + }, + "securitySettings": { + "$ref": "#/definitions/SecuritySettings", + "description": "Security Settings" + }, + "featureSettings": { + "$ref": "#/definitions/FeatureSettings", + "description": "Feature Settings" + } + } + }, + "PatchResourceRequestInput": { + "description": "Patch Request content for Microsoft.DataProtection resources", + "properties": { + "identity": { + "$ref": "#/definitions/DppIdentityDetails", + "description": "Input Managed Identity Details" + }, + "properties": { + "$ref": "#/definitions/PatchBackupVaultInput", + "description": "Resource properties." + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags.", + "type": "object" + } + }, + "title": "PatchResourceRequestInput", + "type": "object" + }, + "PatchResourceGuardInput": { + "description": "Patch Request content for Microsoft.DataProtection Resource Guard resources", + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource Guard tags.", + "type": "object" + } + }, + "title": "PatchResourceGuardInput", + "type": "object" + }, + "PolicyInfo": { + "description": "Policy Info in backupInstance", + "properties": { + "policyId": { + "type": "string" + }, + "policyVersion": { + "readOnly": true, + "type": "string" + }, + "policyParameters": { + "$ref": "#/definitions/PolicyParameters", + "description": "Policy parameters for the backup instance" + } + }, + "required": [ + "policyId" + ], + "title": "PolicyInfo", + "type": "object" + }, + "PolicyParameters": { + "description": "Parameters in Policy", + "type": "object", + "x-ms-mutability": [ + "create", + "read" + ], + "properties": { + "dataStoreParametersList": { + "description": "Gets or sets the DataStore Parameters", + "type": "array", + "items": { + "$ref": "#/definitions/DataStoreParameters" + }, + "x-ms-identifiers": [] + }, + "backupDatasourceParametersList": { + "description": "Gets or sets the Backup Data Source Parameters", + "type": "array", + "items": { + "$ref": "#/definitions/BackupDatasourceParameters" + }, + "x-ms-identifiers": [] + } + } + }, + "ProtectionStatusDetails": { + "description": "Protection status details", + "properties": { + "errorDetails": { + "$ref": "#/definitions/UserFacingError", + "description": "Specifies the protection status error of the resource" + }, + "status": { + "description": "Specifies the protection status of the resource", + "enum": [ + "ConfiguringProtection", + "ConfiguringProtectionFailed", + "ProtectionConfigured", + "ProtectionStopped", + "SoftDeleted", + "SoftDeleting" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Status" + } + } + }, + "title": "ProtectionStatusDetails", + "type": "object" + }, + "RangeBasedItemLevelRestoreCriteria": { + "description": "Item Level target info for restore operation", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ItemLevelRestoreCriteria" + } + ], + "properties": { + "minMatchingValue": { + "description": "minimum value for range prefix match", + "type": "string" + }, + "maxMatchingValue": { + "description": "maximum value for range prefix match", + "type": "string" + } + }, + "x-ms-discriminator-value": "RangeBasedItemLevelRestoreCriteria" + }, + "KubernetesStorageClassRestoreCriteria": { + "description": "Item Level kubernetes storage class target info for restore operation", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ItemLevelRestoreCriteria" + } + ], + "properties": { + "selectedStorageClassName": { + "description": "Selected storage class name", + "type": "string" + }, + "provisioner": { + "description": "Provisioner of the storage class", + "type": "string" + } + }, + "x-ms-discriminator-value": "KubernetesStorageClassRestoreCriteria" + }, + "KubernetesPVRestoreCriteria": { + "description": "Item Level kubernetes persistent volume target info for restore operation", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ItemLevelRestoreCriteria" + } + ], + "properties": { + "name": { + "description": "Selected persistent volume claim name", + "type": "string" + }, + "storageClassName": { + "description": "Selected storage class name for restore operation", + "type": "string" + } + }, + "x-ms-discriminator-value": "KubernetesPVRestoreCriteria" + }, + "KubernetesClusterRestoreCriteria": { + "description": "kubernetes Cluster Backup target info for restore operation", + "required": [ + "includeClusterScopeResources" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ItemLevelRestoreCriteria" + } + ], + "properties": { + "includeClusterScopeResources": { + "description": "Gets or sets the include cluster resources property. This property if enabled will include cluster scope resources during restore.", + "type": "boolean" + }, + "includedNamespaces": { + "description": "Gets or sets the include namespaces property. This property sets the namespaces to be included during restore.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludedNamespaces": { + "description": "Gets or sets the exclude namespaces property. This property sets the namespaces to be excluded during restore.", + "items": { + "type": "string" + }, + "type": "array" + }, + "includedResourceTypes": { + "description": "Gets or sets the include resource types property. This property sets the resource types to be included during restore.", + "items": { + "type": "string" + }, + "type": "array" + }, + "excludedResourceTypes": { + "description": "Gets or sets the exclude resource types property. This property sets the resource types to be excluded during restore.", + "items": { + "type": "string" + }, + "type": "array" + }, + "labelSelectors": { + "description": "Gets or sets the LabelSelectors property. This property sets the resource with such label selectors to be included during restore.", + "items": { + "type": "string" + }, + "type": "array" + }, + "persistentVolumeRestoreMode": { + "description": "Gets or sets the PV (Persistent Volume) Restore Mode property. This property sets whether volumes needs to be restored.", + "enum": [ + "RestoreWithVolumeData", + "RestoreWithoutVolumeData" + ], + "type": "string", + "x-ms-enum": { + "name": "PersistentVolumeRestoreMode", + "modelAsString": true + } + }, + "conflictPolicy": { + "description": "Gets or sets the Conflict Policy property. This property sets policy during conflict of resources during restore.", + "enum": [ + "Skip", + "Patch" + ], + "type": "string", + "x-ms-enum": { + "name": "ExistingResourcePolicy", + "modelAsString": true + } + }, + "namespaceMappings": { + "description": "Gets or sets the Namespace Mappings property. This property sets if namespace needs to be change during restore.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "KubernetesClusterRestoreCriteria" + }, + "RecoveryPointDataStoreDetails": { + "description": "RecoveryPoint datastore details", + "properties": { + "creationTime": { + "format": "date-time", + "type": "string" + }, + "expiryTime": { + "format": "date-time", + "type": "string" + }, + "id": { + "type": "string" + }, + "metaData": { + "type": "string" + }, + "state": { + "type": "string" + }, + "type": { + "type": "string" + }, + "visible": { + "type": "boolean" + }, + "rehydrationExpiryTime": { + "format": "date-time", + "type": "string", + "readOnly": true + }, + "rehydrationStatus": { + "readOnly": true, + "enum": [ + "CREATE_IN_PROGRESS", + "COMPLETED", + "DELETE_IN_PROGRESS", + "DELETED", + "FAILED" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RehydrationStatus" + } + } + }, + "title": "RecoveryPointDataStoreDetails", + "type": "object" + }, + "RehydrationPriority": { + "description": "Priority to be used for rehydration. Values High or Standard", + "enum": [ + "Invalid", + "High", + "Standard" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RehydrationPriority" + } + }, + "RestoreFilesTargetInfo": { + "allOf": [ + { + "$ref": "#/definitions/RestoreTargetInfoBase" + } + ], + "description": "Class encapsulating restore as files target parameters", + "properties": { + "targetDetails": { + "$ref": "#/definitions/TargetDetails", + "description": "Destination of RestoreAsFiles operation, when destination is not a datasource" + } + }, + "required": [ + "recoveryOption", + "targetDetails" + ], + "type": "object", + "x-ms-discriminator-value": "RestoreFilesTargetInfo" + }, + "RestoreJobRecoveryPointDetails": { + "properties": { + "recoveryPointID": { + "type": "string" + }, + "recoveryPointTime": { + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "RestoreTargetInfo": { + "allOf": [ + { + "$ref": "#/definitions/RestoreTargetInfoBase" + } + ], + "description": "Class encapsulating restore target parameters", + "properties": { + "datasourceInfo": { + "$ref": "#/definitions/Datasource", + "description": "Information of target DS" + }, + "datasourceSetInfo": { + "$ref": "#/definitions/DatasourceSet", + "description": "Information of target DS Set" + }, + "datasourceAuthCredentials": { + "$ref": "#/definitions/AuthCredentials", + "description": "Credentials to use to authenticate with data source provider." + } + }, + "required": [ + "datasourceInfo", + "recoveryOption" + ], + "type": "object", + "x-ms-discriminator-value": "RestoreTargetInfo" + }, + "RestoreTargetInfoBase": { + "description": "Base class common to RestoreTargetInfo and RestoreFilesTargetInfo", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of Datasource object, used to initialize the right inherited type", + "type": "string" + }, + "recoveryOption": { + "description": "Recovery Option", + "enum": [ + "FailIfExists" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RecoveryOption" + } + }, + "restoreLocation": { + "description": "Target Restore region", + "type": "string" + } + }, + "required": [ + "objectType", + "recoveryOption" + ], + "type": "object" + }, + "ResourceMoveDetails": { + "description": "ResourceMoveDetails will be returned in response to GetResource call from ARM", + "type": "object", + "properties": { + "operationId": { + "description": "CorrelationId of latest ResourceMove operation attempted", + "type": "string" + }, + "startTimeUtc": { + "description": "Start time in UTC of latest ResourceMove operation attempted. ISO 8601 format.", + "type": "string" + }, + "completionTimeUtc": { + "description": "Completion time in UTC of latest ResourceMove operation attempted. ISO 8601 format.", + "type": "string" + }, + "sourceResourcePath": { + "description": "ARM resource path of source resource", + "type": "string" + }, + "targetResourcePath": { + "description": "ARM resource path of target resource used in latest ResourceMove operation", + "type": "string" + } + } + }, + "RestorableTimeRange": { + "required": [ + "startTime", + "endTime" + ], + "type": "object", + "properties": { + "startTime": { + "description": "Start time for the available restore range", + "type": "string" + }, + "endTime": { + "description": "End time for the available restore range", + "type": "string" + }, + "objectType": { + "type": "string" + } + } + }, + "RetentionTag": { + "description": "Retention tag", + "properties": { + "eTag": { + "description": "Retention Tag version.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Retention Tag version.", + "readOnly": true, + "type": "string" + }, + "tagName": { + "description": "Retention Tag Name to relate it to retention rule.", + "type": "string" + } + }, + "required": [ + "tagName" + ], + "title": "RetentionTag", + "type": "object" + }, + "ScheduleBasedBackupCriteria": { + "allOf": [ + { + "$ref": "#/definitions/BackupCriteria" + } + ], + "description": "Schedule based backup criteria", + "properties": { + "absoluteCriteria": { + "description": "it contains absolute values like \"AllBackup\" / \"FirstOfDay\" / \"FirstOfWeek\" / \"FirstOfMonth\"\r\nand should be part of AbsoluteMarker enum", + "items": { + "enum": [ + "AllBackup", + "FirstOfDay", + "FirstOfMonth", + "FirstOfWeek", + "FirstOfYear" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AbsoluteMarker" + } + }, + "type": "array" + }, + "daysOfMonth": { + "description": "This is day of the month from 1 to 28 other wise last of month", + "items": { + "$ref": "#/definitions/Day" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "daysOfTheWeek": { + "description": "It should be Sunday/Monday/T..../Saturday", + "items": { + "enum": [ + "Friday", + "Monday", + "Saturday", + "Sunday", + "Thursday", + "Tuesday", + "Wednesday" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DayOfWeek" + } + }, + "type": "array" + }, + "monthsOfYear": { + "description": "It should be January/February/....../December", + "items": { + "enum": [ + "April", + "August", + "December", + "February", + "January", + "July", + "June", + "March", + "May", + "November", + "October", + "September" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Month" + } + }, + "type": "array" + }, + "scheduleTimes": { + "description": "List of schedule times for backup", + "items": { + "format": "date-time", + "type": "string" + }, + "type": "array" + }, + "weeksOfTheMonth": { + "description": "It should be First/Second/Third/Fourth/Last", + "items": { + "enum": [ + "First", + "Fourth", + "Last", + "Second", + "Third" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "WeekNumber" + } + }, + "type": "array" + } + }, + "required": [ + "objectType" + ], + "title": "ScheduleBasedBackupCriteria", + "type": "object", + "x-ms-discriminator-value": "ScheduleBasedBackupCriteria" + }, + "ScheduleBasedTriggerContext": { + "allOf": [ + { + "$ref": "#/definitions/TriggerContext" + } + ], + "description": "Schedule based trigger context", + "properties": { + "schedule": { + "$ref": "#/definitions/BackupSchedule", + "description": "Schedule for this backup" + }, + "taggingCriteria": { + "description": "List of tags that can be applicable for given schedule.", + "items": { + "$ref": "#/definitions/TaggingCriteria" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "objectType", + "schedule", + "taggingCriteria" + ], + "title": "ScheduleBasedTriggerContext", + "type": "object", + "x-ms-discriminator-value": "ScheduleBasedTriggerContext" + }, + "SecretStoreBasedAuthCredentials": { + "description": "Secret store based authentication credentials.", + "required": [ + "objectType" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AuthCredentials" + } + ], + "properties": { + "secretStoreResource": { + "$ref": "#/definitions/SecretStoreResource", + "description": "Secret store resource" + } + }, + "x-ms-discriminator-value": "SecretStoreBasedAuthCredentials" + }, + "SecretStoreResource": { + "description": "Class representing a secret store resource.", + "required": [ + "secretStoreType" + ], + "type": "object", + "properties": { + "uri": { + "description": "Uri to get to the resource", + "type": "string" + }, + "secretStoreType": { + "description": "Gets or sets the type of secret store", + "enum": [ + "Invalid", + "AzureKeyVault" + ], + "type": "string", + "x-ms-enum": { + "name": "SecretStoreType", + "modelAsString": true + } + }, + "value": { + "description": "Gets or sets value stored in secret store resource", + "type": "string" + } + } + }, + "SecuritySettings": { + "description": "Class containing security settings of vault", + "type": "object", + "properties": { + "softDeleteSettings": { + "$ref": "#/definitions/SoftDeleteSettings" + }, + "immutabilitySettings": { + "$ref": "#/definitions/ImmutabilitySettings" + } + } + }, + "SoftDeleteSettings": { + "description": "Soft delete related settings", + "type": "object", + "properties": { + "state": { + "description": "State of soft delete", + "enum": [ + "Off", + "On", + "AlwaysOn" + ], + "type": "string", + "x-ms-enum": { + "name": "SoftDeleteState", + "modelAsString": true, + "values": [ + { + "description": "Soft Delete is turned off for the BackupVault", + "value": "Off" + }, + { + "description": "Soft Delete is enabled for the BackupVault but can be turned off", + "value": "On" + }, + { + "description": "Soft Delete is permanently enabled for the BackupVault and the setting cannot be changed", + "value": "AlwaysOn" + } + ] + } + }, + "retentionDurationInDays": { + "description": "Soft delete retention duration", + "format": "double", + "type": "number" + } + } + }, + "SourceLifeCycle": { + "description": "Source LifeCycle", + "properties": { + "deleteAfter": { + "$ref": "#/definitions/DeleteOption" + }, + "sourceDataStore": { + "$ref": "#/definitions/DataStoreInfoBase" + }, + "targetDataStoreCopySettings": { + "items": { + "$ref": "#/definitions/TargetCopySetting" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "deleteAfter", + "sourceDataStore" + ], + "title": "SourceLifeCycle", + "type": "object" + }, + "StorageSetting": { + "description": "Storage setting", + "properties": { + "datastoreType": { + "description": "Gets or sets the type of the datastore.", + "enum": [ + "ArchiveStore", + "OperationalStore", + "VaultStore" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "StorageSettingStoreTypes" + } + }, + "type": { + "description": "Gets or sets the type.", + "enum": [ + "GeoRedundant", + "LocallyRedundant", + "ZoneRedundant" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "StorageSettingTypes" + } + } + }, + "title": "StorageSetting", + "type": "object" + }, + "SupportedFeature": { + "description": "Elements class for feature request", + "type": "object", + "properties": { + "featureName": { + "description": "support feature type.", + "type": "string" + }, + "supportStatus": { + "description": "feature support status", + "enum": [ + "Invalid", + "NotSupported", + "AlphaPreview", + "PrivatePreview", + "PublicPreview", + "GenerallyAvailable" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureSupportStatus", + "modelAsString": true + } + }, + "exposureControlledFeatures": { + "description": "support feature type.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SyncBackupInstanceRequest": { + "description": "Sync BackupInstance Request", + "type": "object", + "properties": { + "syncType": { + "description": "Field indicating sync type e.g. to sync only in case of failure or in all cases", + "enum": [ + "Default", + "ForceResync" + ], + "type": "string", + "x-ms-enum": { + "name": "SyncType", + "modelAsString": true + } + } + } + }, + "TaggingCriteria": { + "description": "Tagging criteria", + "properties": { + "criteria": { + "description": "Criteria which decides whether the tag can be applied to a triggered backup.", + "items": { + "$ref": "#/definitions/BackupCriteria" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "isDefault": { + "description": "Specifies if tag is default.", + "type": "boolean" + }, + "taggingPriority": { + "description": "Retention Tag priority.", + "format": "int64", + "type": "integer" + }, + "tagInfo": { + "$ref": "#/definitions/RetentionTag", + "description": "Retention tag information" + } + }, + "required": [ + "isDefault", + "tagInfo", + "taggingPriority" + ], + "title": "TaggingCriteria", + "type": "object" + }, + "TargetCopySetting": { + "description": "Target copy settings", + "properties": { + "copyAfter": { + "$ref": "#/definitions/CopyOption", + "description": "It can be CustomCopyOption or ImmediateCopyOption." + }, + "dataStore": { + "$ref": "#/definitions/DataStoreInfoBase", + "description": "Info of target datastore" + } + }, + "required": [ + "copyAfter", + "dataStore" + ], + "title": "TargetCopySetting", + "type": "object" + }, + "TargetDetails": { + "description": "Class encapsulating target details, used where the destination is not a datasource", + "properties": { + "filePrefix": { + "description": "Restore operation may create multiple files inside location pointed by Url\r\nBelow will be the common prefix for all of them", + "type": "string" + }, + "restoreTargetLocationType": { + "description": "Denotes the target location where the data will be restored,\r\nstring value for the enum {Microsoft.Internal.AzureBackup.DataProtection.Common.Interface.RestoreTargetLocationType}", + "enum": [ + "Invalid", + "AzureBlobs", + "AzureFiles" + ], + "type": "string", + "x-ms-enum": { + "name": "RestoreTargetLocationType", + "modelAsString": true + } + }, + "url": { + "description": "Url denoting the restore destination. It can point to container / file share etc", + "type": "string" + }, + "targetResourceArmId": { + "description": "Full ARM Id denoting the restore destination. It is the ARM Id pointing to container / file share\r\nThis is optional if the target subscription can be identified with the URL field. If not\r\nthen this is needed if CrossSubscriptionRestore field of BackupVault is in any of the disabled states", + "type": "string" + } + }, + "required": [ + "filePrefix", + "restoreTargetLocationType", + "url" + ], + "type": "object" + }, + "TriggerBackupRequest": { + "description": "Trigger backup request", + "properties": { + "backupRuleOptions": { + "$ref": "#/definitions/AdHocBackupRuleOptions", + "description": "Name for the Rule of the Policy which needs to be applied for this backup" + } + }, + "required": [ + "backupRuleOptions" + ], + "title": "TriggerBackupRequest", + "type": "object" + }, + "TriggerContext": { + "description": "Trigger context", + "discriminator": "objectType", + "properties": { + "objectType": { + "description": "Type of the specific object - used for deserializing", + "type": "string" + } + }, + "required": [ + "objectType" + ], + "title": "TriggerContext", + "type": "object" + }, + "UserFacingError": { + "description": "Error object used by layers that have access to localized content, and propagate that to user", + "properties": { + "code": { + "description": "Unique code for this error", + "type": "string" + }, + "details": { + "description": "Additional related Errors", + "items": { + "$ref": "#/definitions/UserFacingError" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "innerError": { + "$ref": "#/definitions/InnerError", + "description": "Inner Error" + }, + "isRetryable": { + "description": "Whether the operation will be retryable or not", + "type": "boolean" + }, + "isUserError": { + "description": "Whether the operation is due to a user error or service error", + "type": "boolean" + }, + "properties": { + "description": "Any key value pairs that can be injected inside error object", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "message": { + "type": "string" + }, + "recommendedAction": { + "description": "RecommendedAction � localized.", + "items": { + "type": "string" + }, + "type": "array" + }, + "target": { + "description": "Target of the error.", + "type": "string" + } + }, + "type": "object" + }, + "ValidateForBackupRequest": { + "description": "Validate for backup request", + "properties": { + "backupInstance": { + "$ref": "#/definitions/BackupInstance" + } + }, + "required": [ + "backupInstance" + ], + "title": "ValidateForBackupRequest", + "type": "object" + }, + "ValidateRestoreRequestObject": { + "description": "Validate restore request object", + "properties": { + "restoreRequestObject": { + "$ref": "#/definitions/AzureBackupRestoreRequest", + "description": "Gets or sets the restore request object." + } + }, + "required": [ + "restoreRequestObject" + ], + "title": "ValidateRestoreRequestObject", + "type": "object" + }, + "ResourceGuard": { + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the BackupVault resource", + "enum": [ + "Failed", + "Provisioning", + "Succeeded", + "Unknown", + "Updating" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "allowAutoApprovals": { + "description": "This flag indicates whether auto approval is allowed or not.", + "type": "boolean", + "readOnly": true + }, + "resourceGuardOperations": { + "description": "{readonly} List of operation details those are protected by the ResourceGuard resource", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGuardOperation" + }, + "x-ms-identifiers": [], + "readOnly": true + }, + "vaultCriticalOperationExclusionList": { + "description": "List of critical operations which are not protected by this resourceGuard", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "Description about the pre-req steps to perform all the critical operations.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceGuardOperation": { + "description": "This class contains all the details about a critical operation.", + "type": "object", + "properties": { + "vaultCriticalOperation": { + "description": "Name of the critical operation.", + "type": "string", + "readOnly": true + }, + "requestResourceType": { + "description": "Type of resource request.", + "type": "string", + "readOnly": true + } + } + }, + "ResourceGuardResource": { + "allOf": [ + { + "$ref": "#/definitions/DppBaseTrackedResource" + } + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ResourceGuard", + "description": "ResourceGuardResource properties" + } + } + }, + "ResourceGuardResourceList": { + "description": "List of ResourceGuard resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DppTrackedResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGuardResource" + } + } + } + }, + "ResourceGuardOperationDetail": { + "description": "VaultCritical Operation protected by a resource guard", + "type": "object", + "properties": { + "vaultCriticalOperation": { + "type": "string" + }, + "defaultResourceRequest": { + "type": "string" + } + } + }, + "ResourceGuardProxyBase": { + "description": "ResourceGuardProxyBase object, used in ResourceGuardProxyBaseResource", + "type": "object", + "properties": { + "resourceGuardResourceId": { + "type": "string" + }, + "resourceGuardOperationDetails": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGuardOperationDetail" + }, + "x-ms-identifiers": [] + }, + "lastUpdatedTime": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "ResourceGuardProxyBaseResource": { + "description": "ResourceGuardProxyBaseResource object, used for response and request bodies for ResourceGuardProxy APIs", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DppResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ResourceGuardProxyBase", + "description": "ResourceGuardProxyBaseResource properties" + } + } + }, + "ResourceGuardProxyBaseResourceList": { + "description": "List of ResourceGuardProxyBase resources", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DppResourceList" + } + ], + "properties": { + "value": { + "description": "List of resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGuardProxyBaseResource" + } + } + } + }, + "UnlockDeleteRequest": { + "description": "Request body of unlock delete API.", + "type": "object", + "properties": { + "resourceGuardOperationRequests": { + "type": "array", + "items": { + "type": "string" + } + }, + "resourceToBeDeleted": { + "type": "string" + } + } + }, + "UnlockDeleteResponse": { + "description": "Response of Unlock Delete API.", + "type": "object", + "properties": { + "unlockDeleteExpiryTime": { + "description": "This is the time when unlock delete privileges will get expired.", + "type": "string" + } + } + } + }, + "parameters": { + "VaultName": { + "name": "vaultName", + "in": "path", + "description": "The name of the backup vault.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BackupInstanceName": { + "name": "backupInstanceName", + "in": "path", + "description": "The name of the backup instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceId": { + "name": "resourceId", + "in": "path", + "description": "ARM path of the resource to be protected using Microsoft.DataProtection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + }, + "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." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/DeleteBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/DeleteBackupInstance.json new file mode 100644 index 000000000000..0b3fedb70b2b --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/DeleteBackupInstance.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "backupInstanceName": "testInstance1", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "204": {}, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json new file mode 100644 index 000000000000..d2145c340dbb --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/FindRestorableTimeRanges.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "Blob-Backup", + "vaultName": "ZBlobBackupVaultBVTD3", + "backupInstanceName": "zblobbackuptestsa58", + "api-version": "2023-04-01-preview", + "parameters": { + "sourceDataStoreType": "OperationalStore", + "startTime": "2020-10-17T23:28:17.6829685Z", + "endTime": "2021-02-24T00:35:17.6829685Z" + } + }, + "responses": { + "200": { + "body": { + "id": "zblobbackuptestsa58", + "type": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges", + "properties": { + "restorableTimeRanges": [ + { + "startTime": "2021-02-23T18:33:51.6349708Z", + "endTime": "2021-02-24T00:35:17.0000000Z", + "objectType": "RestorableTimeRange" + } + ], + "objectType": "AzureBackupFindRestorableTimeRangesResponse" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetBackupInstance.json new file mode 100644 index 000000000000..837e95195bd8 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetBackupInstance.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "tags": { + "key1": "val1" + }, + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2" + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioning", + "objectType": "BackupInstance" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json new file mode 100644 index 000000000000..024fde4e0387 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetBackupInstanceOperationResult.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "backupInstanceName": "testInstance1", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupInstances/testInstance1", + "name": "testInstance1", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "properties": { + "friendlyName": "testInstance1", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/backupPolicies/PratikPolicy1", + "policyVersion": "3.2" + }, + "protectionStatus": { + "status": "ConfiguringProtection" + }, + "provisioningState": "Provisioned", + "objectType": "BackupInstance" + } + } + }, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupvaults/swaggerExample/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetRecoveryPoint.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetRecoveryPoint.json new file mode 100644 index 000000000000..aaac11a80f28 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/GetRecoveryPoint.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "recoveryPointId": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints", + "properties": { + "objectType": "AzureBackupDiscreteRecoveryPoint", + "recoveryPointTime": "2019-03-01T13:00:00Z", + "recoveryPointType": "Full", + "friendlyName": "panbha4", + "recoveryPointDataStoresDetails": [ + { + "id": "0ff03512-b333-4509-a6c7-12164c8b1dce", + "type": "Snapshot", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + }, + { + "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1", + "type": "BackupStorage", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListBackupInstances.json new file mode 100644 index 000000000000..8e6db7e954b4 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListBackupInstances.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "tags": { + "key1": "val1" + }, + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2" + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioning", + "objectType": "BackupInstance" + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json new file mode 100644 index 000000000000..e0307d8d00c2 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListBackupInstancesExtensionRouting.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "resourceId": "subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "friendlyName": "testDisk", + "dataSourceInfo": { + "resourceID": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk", + "resourceUri": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk", + "datasourceType": "Microsoft.Compute/disks", + "resourceName": "testDisk", + "resourceType": "Microsoft.Compute/disks", + "resourceLocation": "eastus2euap", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk", + "resourceUri": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk", + "datasourceType": "Microsoft.Compute/disks", + "resourceName": "testDisk", + "resourceType": "Microsoft.Compute/disks", + "resourceLocation": "eastus2euap", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/policyRG/providers/Microsoft.DataProtection/backupVaults/jeczrsecy/backupPolicies/disk", + "policyVersion": "", + "policyParameters": { + "dataStoreParametersList": [ + { + "objectType": "AzureOperationalStoreParameters", + "dataStoreType": "OperationalStore", + "resourceGroupId": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/policyRG" + } + ] + } + }, + "protectionStatus": { + "status": "ProtectionConfigured" + }, + "currentProtectionState": "ProtectionConfigured", + "provisioningState": "Succeeded", + "objectType": "BackupInstance" + }, + "id": "/subscriptions/36d32b25-3dc7-41b0-bde1-397500644591/resourceGroups/testRG/providers/Microsoft.Compute/disks/testDisk/providers/Microsoft.DataProtection/backupInstances/testDiskBI1-testDiskBI1-7664c12f-4d0a-440f-a0dc-b64f708b10e3", + "name": "testDiskBI1-testDiskBI1-7664c12f-4d0a-440f-a0dc-b64f708b10e3", + "type": "Microsoft.DataProtection/backupVaults/backupInstances" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListRecoveryPoints.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListRecoveryPoints.json new file mode 100644 index 000000000000..548f4cb0223b --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ListRecoveryPoints.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35", + "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints", + "properties": { + "objectType": "AzureBackupDiscreteRecoveryPoint", + "recoveryPointTime": "2019-03-01T13:00:00Z", + "recoveryPointType": "Full", + "friendlyName": "panbha4", + "expiryTime": "2023-03-01T13:00:00Z", + "recoveryPointDataStoresDetails": [ + { + "id": "0ff03512-b333-4509-a6c7-12164c8b1dce", + "type": "Snapshot", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + }, + { + "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1", + "type": "BackupStorage", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + } + ] + } + }, + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints", + "properties": { + "objectType": "AzureBackupDiscreteRecoveryPoint", + "recoveryPointTime": "2019-03-01T13:00:00Z", + "recoveryPointType": "Full", + "friendlyName": "panbha4", + "recoveryPointDataStoresDetails": [ + { + "id": "808cfd30-722e-4bab-85f6-4a9d01ffc6f2", + "type": "Snapshot", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + }, + { + "id": "798cfd30-722e-4bab-85f6-4a9d01ffc6f3", + "type": "BackupStorage", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/PutBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/PutBackupInstance.json new file mode 100644 index 000000000000..faa9bbbf0813 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/PutBackupInstance.json @@ -0,0 +1,167 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "tags": { + "key1": "val1" + }, + "properties": { + "objectType": "BackupInstance", + "friendlyName": "harshitbi2", + "dataSourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "dataSourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyParameters": { + "dataStoreParametersList": [ + { + "objectType": "AzureOperationalStoreParameters", + "dataStoreType": "OperationalStore", + "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest" + } + ] + } + }, + "validationType": "ShallowValidation" + } + } + }, + "responses": { + "201": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + }, + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "tags": { + "key1": "val1" + }, + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2", + "policyParameters": { + "dataStoreParametersList": [ + { + "objectType": "AzureOperationalStoreParameters", + "dataStoreType": "OperationalStore", + "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest" + } + ] + } + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioning", + "objectType": "BackupInstance" + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/testInstance1/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupInstances/harshitbi2", + "name": "harshitbi2", + "type": "Microsoft.DataProtection/backupVaults/backupInstances", + "tags": { + "key1": "val1" + }, + "properties": { + "friendlyName": "harshitbi2", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "testdb", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "OssDB", + "resourceName": "viveksipgtest", + "resourceType": "OssDB", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1", + "policyVersion": "3.2", + "policyParameters": { + "dataStoreParametersList": [ + { + "objectType": "AzureOperationalStoreParameters", + "dataStoreType": "OperationalStore", + "resourceGroupId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest" + } + ] + } + }, + "protectionStatus": { + "status": "NotProtected" + }, + "provisioningState": "Provisioned", + "objectType": "BackupInstance" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ResumeBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ResumeBackups.json new file mode 100644 index 000000000000..eba43e654d62 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ResumeBackups.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ResumeProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ResumeProtection.json new file mode 100644 index 000000000000..eba43e654d62 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ResumeProtection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/StopProtection.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/StopProtection.json new file mode 100644 index 000000000000..eba43e654d62 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/StopProtection.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/SuspendBackups.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/SuspendBackups.json new file mode 100644 index 000000000000..eba43e654d62 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/SuspendBackups.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/SyncBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/SyncBackupInstance.json new file mode 100644 index 000000000000..579a3a9c49a4 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/SyncBackupInstance.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2023-04-01-preview", + "parameters": { + "syncType": "Default" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerBackup.json new file mode 100644 index 000000000000..f39e1889cff9 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerBackup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "backupRuleOptions": { + "ruleName": "BackupWeekly", + "triggerOption": { + "retentionTagOverride": "yearly" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRehydrate.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRehydrate.json new file mode 100644 index 000000000000..b7fc3e61db7e --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRehydrate.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "recoveryPointId": "hardcodedRP", + "rehydrationRetentionDuration": "7D", + "rehydrationPriority": "High" + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestore.json new file mode 100644 index 000000000000..a99938203d49 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestore.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "objectType": "RestoreTargetInfo", + "recoveryOption": "FailIfExists", + "datasourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb", + "resourceName": "targetdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "restoreLocation": "southeastasia" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json new file mode 100644 index 000000000000..e94aba5f1b4c --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestoreAsFiles.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "targetDetails": { + "url": "https://teststorage.blob.core.windows.net/restoretest", + "filePrefix": "restoredblob", + "restoreTargetLocationType": "AzureBlobs" + }, + "restoreLocation": "southeastasia", + "recoveryOption": "FailIfExists", + "objectType": "RestoreFilesTargetInfo" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/testInstance1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json new file mode 100644 index 000000000000..7f5854f02754 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/TriggerRestoreWithRehydration.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "objectType": "AzureBackupRestoreWithRehydrationRequest", + "recoveryPointId": "hardcodedRP", + "rehydrationRetentionDuration": "7D", + "rehydrationPriority": "High", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "objectType": "RestoreTargetInfo", + "recoveryOption": "FailIfExists", + "datasourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "restoreLocation": "southeastasia" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ValidateForBackup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ValidateForBackup.json new file mode 100644 index 000000000000..01735d2c70a3 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ValidateForBackup.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "backupInstance": { + "objectType": "BackupInstance", + "friendlyName": "harshitbi2", + "dataSourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "dataSourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "OssDB" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/Backupvaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ValidateRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ValidateRestore.json new file mode 100644 index 000000000000..eee95aaf6784 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/BackupInstanceOperations/ValidateRestore.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "restoreRequestObject": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "objectType": "RestoreTargetInfo", + "recoveryOption": "FailIfExists", + "datasourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb", + "resourceName": "targetdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "restoreLocation": "southeastasia" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CheckfeatureSupport.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CheckfeatureSupport.json new file mode 100644 index 000000000000..41177af75329 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CheckfeatureSupport.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "location": "WestUS", + "api-version": "2023-04-01-preview", + "parameters": { + "featureType": "DataSourceType", + "objectType": "FeatureValidationRequest" + } + }, + "responses": { + "200": { + "body": { + "featureType": "DataSourceType", + "features": [ + { + "featureName": "Microsoft.Storage/storageAccounts/blobServices", + "supportStatus": "PrivatePreview", + "exposureControlledFeatures": [] + }, + { + "featureName": "Microsoft.DBforPostgreSQL/servers/databases", + "supportStatus": "PublicPreview", + "exposureControlledFeatures": [] + } + ], + "objectType": "FeatureValidationResponse" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchCrossRegionRestoreJob.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchCrossRegionRestoreJob.json new file mode 100644 index 000000000000..e6de1619103f --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchCrossRegionRestoreJob.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "resourceGroupName": "BugBash1", + "location": "west us", + "parameters": { + "sourceRegion": "east us", + "sourceBackupVaultId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11", + "jobId": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae" + }, + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2", + "policyName": "jakavetdailypolicy", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb2", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T03:00:03.7604146Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "east us", + "extendedInfo": { + "subTasks": [ + { + "taskId": 1, + "taskName": "Trigger Backup", + "taskStatus": "Started" + } + ], + "additionalDetails": { + "RetentionTag": "Default", + "PolicyRuleName": "BackupWeekly", + "TaskId": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9" + } + } + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchCrossRegionRestoreJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchCrossRegionRestoreJobs.json new file mode 100644 index 000000000000..c4f3344dc37d --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchCrossRegionRestoreJobs.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "resourceGroupName": "BugBash1", + "location": "east us", + "api-version": "2023-04-01-preview", + "parameters": { + "sourceRegion": "east us", + "sourceBackupVaultId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "activityID": "932925c4-3d81-4550-8105-c7f7b0a934c5", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/3048870f-b1b7-44c4-b078-368da3fd000e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy2", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb4", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb4", + "policyName": "jakavetPolicy2", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb4", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-16T05:00:08.1746833Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/8989416e-7573-4836-8cf1-0e90954f1002", + "name": "8989416e-7573-4836-8cf1-0e90954f1002", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "b4f32e03-ded0-46fc-9afc-91853878efcd", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/943c60db-c033-4d93-bb00-66048474e00e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy3", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb5", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb5", + "policyName": "jakavetPolicy3", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb5", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-16T18:00:03.6660733Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/ad218c05-242a-47c2-b7b7-c16bd0f8870c", + "name": "ad218c05-242a-47c2-b7b7-c16bd0f8870c", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2", + "policyName": "jakavetdailypolicy", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb2", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T03:00:03.7604146Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "94052cf1-a47f-4c1b-93e7-79e07b2bd008-Tue Mar 17 2021 11:11:48 GMT+0530 (India Standard Time)-Ibz", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/0b247869-b8be-4885-b832-8ac4cdf5b00e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy1", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb3", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb3", + "policyName": "jakavetPolicy1", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb3", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T11:11:50.5595259Z", + "endTime": "2021-03-17T11:14:02.5319646Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Succeeded", + "isUserTriggered": true, + "supportedActions": [ + "" + ], + "duration": "00:02:11.9724387", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/43252662-1b43-44fd-a856-0055665cb097", + "name": "43252662-1b43-44fd-a856-0055665cb097", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchSecondaryRPs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchSecondaryRPs.json new file mode 100644 index 000000000000..744bb8a8be36 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/FetchSecondaryRPs.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "api-version": "2023-04-01-preview", + "location": "WestUS", + "parameters": { + "sourceBackupInstanceId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34", + "sourceRegion": "EastUS" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5e35", + "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints", + "properties": { + "objectType": "AzureBackupDiscreteRecoveryPoint", + "recoveryPointTime": "2019-03-01T13:00:00Z", + "recoveryPointType": "Full", + "friendlyName": "panbha4", + "expiryTime": "2023-03-01T13:00:00Z", + "recoveryPointDataStoresDetails": [ + { + "id": "0ff03512-b333-4509-a6c7-12164c8b1dce", + "type": "Snapshot", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + }, + { + "id": "5d8cfd30-722e-4bab-85f6-4a9d01ffc6f1", + "type": "BackupStorage", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + } + ] + } + }, + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/HelloTest/providers/Microsoft.DataProtection/backupVaults/HelloTestVault/backupInstances/653213d-c5b3-44f6-a0d9-db3c4f9d8e34/recoveryPoints/7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "name": "7fb2cddd-c5b3-44f6-a0d9-db3c4f9d5f25", + "type": "microsoft.dataprotection/backupvaults/backupInstances/recoveryPoints", + "properties": { + "objectType": "AzureBackupDiscreteRecoveryPoint", + "recoveryPointTime": "2019-03-01T13:00:00Z", + "recoveryPointType": "Full", + "friendlyName": "panbha4", + "recoveryPointDataStoresDetails": [ + { + "id": "808cfd30-722e-4bab-85f6-4a9d01ffc6f2", + "type": "Snapshot", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + }, + { + "id": "798cfd30-722e-4bab-85f6-4a9d01ffc6f3", + "type": "BackupStorage", + "creationTime": "2019-03-01T13:00:00Z", + "metaData": "123456" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/TriggerCrossRegionRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/TriggerCrossRegionRestore.json new file mode 100644 index 000000000000..5baabe175c5a --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/TriggerCrossRegionRestore.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "location": "EastAsia", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "restoreRequestObject": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "objectType": "RestoreTargetInfo", + "recoveryOption": "FailIfExists", + "datasourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb", + "resourceName": "targetdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "restoreLocation": "southeastasia" + } + }, + "crossRegionRestoreDetails": { + "sourceRegion": "east asia", + "sourceBackupInstanceId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/BackupInstances/harshitbi1" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/ValidateCrossRegionRestore.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/ValidateCrossRegionRestore.json new file mode 100644 index 000000000000..5baabe175c5a --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/CrossRegionRestore/ValidateCrossRegionRestore.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "location": "EastAsia", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1", + "parameters": { + "restoreRequestObject": { + "objectType": "AzureBackupRecoveryPointBasedRestoreRequest", + "recoveryPointId": "hardcodedRP", + "sourceDataStoreType": "VaultStore", + "sourceResourceId": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "restoreTargetInfo": { + "objectType": "RestoreTargetInfo", + "recoveryOption": "FailIfExists", + "datasourceSetInfo": { + "objectType": "DatasourceSet", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceInfo": { + "objectType": "Datasource", + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/targetdb", + "resourceName": "targetdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceUri": "", + "resourceLocation": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases" + }, + "datasourceAuthCredentials": { + "secretStoreResource": { + "uri": "https://samplevault.vault.azure.net/secrets/credentials", + "secretStoreType": "AzureKeyVault" + }, + "objectType": "SecretStoreBasedAuthCredentials" + }, + "restoreLocation": "southeastasia" + } + }, + "crossRegionRestoreDetails": { + "sourceRegion": "east asia", + "sourceBackupInstanceId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/BackupInstances/harshitbi1" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupInstances/harshitbi1/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json new file mode 100644 index 000000000000..9de274f921bc --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/GetDeletedBackupInstance.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview", + "backupInstanceName": "testInstance1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/deletedBackupInstances/testInstance1", + "name": "testInstance1", + "type": "Microsoft.DataProtection/backupVaults/deletedBackupInstances", + "properties": { + "friendlyName": "testInstance1", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "deletionInfo": { + "deletionTime": "2022-05-04T00:00:36.6660445Z", + "scheduledPurgeTime": "2022-05-20T00:00:36.6660445Z", + "billingEndDate": "2022-05-06T00:00:36.6660445Z", + "deleteActivityID": "1e9ec790-d198-4efb-bbd7-e4669d5351a4" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1" + }, + "protectionStatus": { + "status": "SoftDeleted" + }, + "provisioningState": "Succeeded", + "objectType": "DeletedBackupInstance" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json new file mode 100644 index 000000000000..8155ae903175 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/ListDeletedBackupInstances.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PratikPrivatePreviewVault1", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/deletedBackupInstances/testInstance1", + "name": "testInstance1", + "type": "Microsoft.DataProtection/backupVaults/deletedBackupInstances", + "properties": { + "friendlyName": "testInstance1", + "dataSourceInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest/databases/testdb", + "resourceUri": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceName": "testdb", + "resourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceLocation": "", + "objectType": "Datasource" + }, + "dataSourceSetInfo": { + "resourceID": "/subscriptions/f75d8d8b-6735-4697-82e1-1a7a3ff0d5d4/resourceGroups/viveksipgtest/providers/Microsoft.DBforPostgreSQL/servers/viveksipgtest", + "resourceUri": "", + "datasourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "resourceName": "viveksipgtest", + "resourceType": "Microsoft.DBforPostgreSQL/servers", + "resourceLocation": "", + "objectType": "DatasourceSet" + }, + "deletionInfo": { + "deletionTime": "2022-05-04T00:00:36.6660445Z", + "scheduledPurgeTime": "2022-05-20T00:00:36.6660445Z", + "billingEndDate": "2022-05-06T00:00:36.6660445Z", + "deleteActivityID": "1e9ec790-d198-4efb-bbd7-e4669d5351a4" + }, + "policyInfo": { + "policyId": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PratikPrivatePreviewVault1/backupPolicies/PratikPolicy1" + }, + "protectionStatus": { + "status": "SoftDeleted" + }, + "provisioningState": "Succeeded", + "objectType": "DeletedBackupInstance" + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json new file mode 100644 index 000000000000..eba43e654d62 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/DeletedBackupInstanceOperations/UndeleteDeletedBackupInstance.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "testrg", + "vaultName": "testvault", + "backupInstanceName": "testbi", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupInstances/testbi/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/testrg/providers/Microsoft.DataProtection/backupVaults/testvault/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + }, + "200": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationResult.json new file mode 100644 index 000000000000..ecaf7f6e1222 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationResult.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "location": "WestUS", + "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/operationResults/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-01-01", + "Azure-AsyncOperation": "https://api-dogfood.resources.windows-int.net/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/providers/Microsoft.DataProtection/locations/westus/operationStatus/ZTA4YjQ0ZGYtYmNkNS00YTk1LWFjZTMtOTc1MjNmZWIxYWZlO2Y1ODg1MzA3LWJkNjItNDQ2OC05ZjZlLTJkMGM2NjNiNmJmNg==?api-version=2021-01-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "jobId": "c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "objectType": "OperationJobExtendedInfo" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatus.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatus.json new file mode 100644 index 000000000000..bc31c402e43c --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatus.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "location": "WestUS", + "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/providers/Microsoft.DataProtection/locations/WestUS/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "status": "Succeeded", + "startTime": "2019-11-20T09:49:44.0478496Z", + "endTime": "2019-11-20T09:49:46Z" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatusRGContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatusRGContext.json new file mode 100644 index 000000000000..8f522aedb30e --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatusRGContext.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "status": "Succeeded", + "startTime": "2019-11-20T09:49:44.0478496Z", + "endTime": "2019-11-20T09:49:46Z" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatusVaultContext.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatusVaultContext.json new file mode 100644 index 000000000000..e80247fba2be --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/GetOperationStatusVaultContext.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "operationId": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "name": "MjkxOTMyODMtYTE3My00YzJjLTg5NjctN2E4MDIxNDA3NjA2OzdjNGE2ZWRjLWJjMmItNDRkYi1hYzMzLWY1YzEwNzk5Y2EyOA==", + "status": "Succeeded", + "startTime": "2019-11-20T09:49:44.0478496Z", + "endTime": "2019-11-20T09:49:46Z" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/GetExportJobsOperationResult.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/GetExportJobsOperationResult.json new file mode 100644 index 000000000000..09c20f5c6460 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/GetExportJobsOperationResult.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "operationId": "00000000-0000-0000-0000-000000000000", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "blobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000", + "blobSasKey": "someKey", + "excelFileBlobUrl": "https://azureblob.blob.core.windows.net/reportcontainer/exportjobsreport00000000-0000-0000-0000-000000000000_ExcelFile.xlsx", + "excelFileBlobSasKey": "someKey" + } + }, + "202": { + "headers": { + "Retry-After": 60, + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2023-04-01-preview" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/GetJob.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/GetJob.json new file mode 100644 index 000000000000..060676acaba9 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/GetJob.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "resourceGroupName": "BugBash1", + "vaultName": "BugBashVaultForCCYv11", + "jobId": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2", + "policyName": "jakavetdailypolicy", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb2", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T03:00:03.7604146Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap", + "extendedInfo": { + "subTasks": [ + { + "taskId": 1, + "taskName": "Trigger Backup", + "taskStatus": "Started" + } + ], + "additionalDetails": { + "RetentionTag": "Default", + "PolicyRuleName": "BackupWeekly", + "TaskId": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9" + } + } + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/ListJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/ListJobs.json new file mode 100644 index 000000000000..d8478006e7f0 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/ListJobs.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "resourceGroupName": "BugBash1", + "vaultName": "BugBashVaultForCCYv11", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "activityID": "932925c4-3d81-4550-8105-c7f7b0a934c5", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/3048870f-b1b7-44c4-b078-368da3fd000e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy2", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb4", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb4", + "policyName": "jakavetPolicy2", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb4", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-16T05:00:08.1746833Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/8989416e-7573-4836-8cf1-0e90954f1002", + "name": "8989416e-7573-4836-8cf1-0e90954f1002", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "b4f32e03-ded0-46fc-9afc-91853878efcd", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/943c60db-c033-4d93-bb00-66048474e00e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy3", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb5", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb5", + "policyName": "jakavetPolicy3", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb5", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-16T18:00:03.6660733Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/ad218c05-242a-47c2-b7b7-c16bd0f8870c", + "name": "ad218c05-242a-47c2-b7b7-c16bd0f8870c", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "c4344fb4-7c11-43a4-8307-7ae7c7fb09b9", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/28460a9d-707a-45f3-ace6-b16284c2900e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetdailypolicy", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb2", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb2", + "policyName": "jakavetdailypolicy", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb2", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T03:00:03.7604146Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Started", + "isUserTriggered": false, + "supportedActions": [], + "duration": "00:00:00", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "name": "3c60cb49-63e8-4b21-b9bd-26277b3fdfae", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + }, + { + "properties": { + "activityID": "94052cf1-a47f-4c1b-93e7-79e07b2bd008-Tue Mar 17 2021 11:11:48 GMT+0530 (India Standard Time)-Ibz", + "subscriptionId": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "backupInstanceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupInstances/0b247869-b8be-4885-b832-8ac4cdf5b00e", + "policyId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/backupVaults/BugBashVaultForCCYv11/backupPolicies/jakavetPolicy1", + "dataSourceId": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/DppPostgresTestingCcy/providers/Microsoft.DBforPostgreSQL/servers/mabtestingccybasicv11/databases/bugbashdb3", + "vaultName": "BugBashVaultForCCYv11", + "backupInstanceFriendlyName": "mabtestingccybasicv11\\bugbashdb3", + "policyName": "jakavetPolicy1", + "sourceResourceGroup": "DppPostgresTestingCcy", + "dataSourceSetName": "mabtestingccybasicv11", + "dataSourceName": "bugbashdb3", + "progressEnabled": false, + "sourceSubscriptionID": "62b829ee-7936-40c9-a1c9-47a93f9f3965", + "startTime": "2021-03-17T11:11:50.5595259Z", + "endTime": "2021-03-17T11:14:02.5319646Z", + "dataSourceType": "Microsoft.DBforPostgreSQL/servers/databases", + "operationCategory": "Backup", + "operation": "Backup", + "status": "Succeeded", + "isUserTriggered": true, + "supportedActions": [ + "" + ], + "duration": "00:02:11.9724387", + "dataSourceLocation": "centraluseuap" + }, + "id": "/subscriptions/62b829ee-7936-40c9-a1c9-47a93f9f3965/resourceGroups/BugBash1/providers/Microsoft.DataProtection/Backupvaults/BugBashVaultForCCYv11/backupJobs/43252662-1b43-44fd-a856-0055665cb097", + "name": "43252662-1b43-44fd-a856-0055665cb097", + "type": "Microsoft.DataProtection/Backupvaults/backupJobs" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/TriggerExportJobs.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/TriggerExportJobs.json new file mode 100644 index 000000000000..08913c1cf0ca --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/JobCRUD/TriggerExportJobs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "SwaggerTestRg", + "vaultName": "NetSDKTestRsVault", + "api-version": "2023-04-01-preview" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.DataProtection/backupVaults/NetSDKTestRsVault/backupJobs/operations/00000000-0000-0000-0000-000000000000?api-version=2023-04-01-preview", + "Retry-After": 60 + } + }, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/Operations/List.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/Operations/List.json new file mode 100644 index 000000000000..60e8a40548dc --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/Operations/List.json @@ -0,0 +1,533 @@ +{ + "parameters": { + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataProtection/locations/getBackupStatus/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Status", + "operation": "Check Backup Status for Vault", + "description": "Check Backup Status for Recovery Services Vaults" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Create a Backup Instance", + "description": "Creates a Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Delete Backup Instance", + "description": "Deletes the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Instance Details", + "description": "Returns details of the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Instances", + "description": "Returns all Backup Instances" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/backup/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Backup Backup Instance", + "description": "Performs Backup on the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/sync/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Sync Backup Instance", + "description": "Sync operation retries last failed operation on backup instance to bring it to a valid state." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/stopProtection/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Stop Protection of Backup Instance", + "description": "Stop Protection operation stops both backup and retention schedules of backup instance. Existing data will be retained forever." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/suspendBackups/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Suspend Backups of Backup Instance", + "description": "Suspend Backups operation stops only backups of backup instance. Retention activities will continue and hence data will be ratained as per policy." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeProtection/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Resume Protection of Backup Instance", + "description": "Resume protection of a ProtectionStopped BI." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/resumeBackups/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Resume Backups of Backup Instance", + "description": "Resume Backups for a BackupsSuspended BI." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/validateRestore/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Validate for Restore of Backup Instance", + "description": "Validates for Restore of the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/restore/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Instance", + "operation": "Restore Backup Instance", + "description": "Triggers restore on the Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Create Backup Policy", + "description": "Creates Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Delete Backup Policy", + "description": "Deletes the Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Get Backup Policy details", + "description": "Returns details of the Backup Policy" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupPolicies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Policies", + "operation": "Get Backup Policies", + "description": "Returns all Backup Policies" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Get the list of ResourceGuard proxies for a resource", + "description": "Get the list of ResourceGuard proxies for a resource" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Get ResourceGuard proxy", + "description": "Get ResourceGuard proxy operation gets an object representing the Azure resource of type 'ResourceGuard proxy'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Create ResourceGuard proxy", + "description": "Create ResourceGuard proxy operation creates an Azure resource of type 'ResourceGuard Proxy'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Delete ResourceGuard proxy", + "description": "The Delete ResourceGuard proxy operation deletes the specified Azure resource of type 'ResourceGuard proxy'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/unlockDelete/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guard Proxy", + "operation": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation", + "description": "Unlock delete ResourceGuard proxy operation unlocks the next delete critical operation" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Recovery Points", + "operation": "Get Recovery Point Details", + "description": "Returns details of the Recovery Point" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/recoveryPoints/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Recovery Points", + "operation": "Get Recovery Points", + "description": "Returns all Recovery Points" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupInstances/findRestorableTimeRanges/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Restorable Time Ranges", + "operation": "Find Restorable Time Ranges", + "description": "Finds Restorable Time Ranges" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Create Backup Vault", + "description": "Create BackupVault operation creates an Azure resource of type 'Backup Vault'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Operation Result of a Patch Operation for a Backup Vault", + "description": "Gets Operation Result of a Patch Operation for a Backup Vault" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/checkNameAvailability/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Check if the requested BackupVault Name is Available", + "description": "Checks if the requested BackupVault Name is Available" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Backup Vaults in a Resource Group", + "description": "Gets list of Backup Vaults in a Resource Group" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Vaults", + "operation": "Get Backup Vaults in a Subscription", + "description": "Gets list of Backup Vaults in a Subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Create ResourceGuard", + "description": "Create ResourceGuard operation creates an Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard", + "description": "The Get ResourceGuard operation gets an object representing the Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/delete", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Delete ResourceGuard", + "description": "The Delete ResourceGuard operation deletes the specified Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuards in a Resource Group", + "description": "Gets list of ResourceGuards in a Resource Group" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/providers/resourceGuards/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuards in a Subscription", + "description": "Gets list of ResourceGuards in a Subscription" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/write", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Update ResourceGuard", + "description": "Update ResouceGuard operation updates an Azure resource of type 'ResourceGuard'" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard operation request info", + "description": "Gets ResourceGuard operation request info" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/resourceGuards/{operationName}/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Guards", + "operation": "Get ResourceGuard default operation request info", + "description": "Gets ResourceGuard default operation request info" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/providers/locations/checkFeatureSupport/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "Validate if a feature is supported", + "description": "Validates if a feature is supported" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/subscriptions/resourceGroups/providers/operationStatus/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Status", + "operation": "Get Backup Operation Status", + "description": "Returns Backup Operation Status for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/locations/operationResults/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Operation Results", + "operation": "Get Backup Operation Result", + "description": "Returns Backup Operation Result for Backup Vault." + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/validateForBackup/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Validate Backup", + "operation": "Validate for backup of Backup Instance", + "description": "Validates for backup of Backup Instance" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/backupVaults/backupJobs/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Jobs", + "operation": "Backup Jobs", + "description": "Get Jobs list" + }, + "origin": "user" + }, + { + "name": "Microsoft.RecoveryServices/Vaults/backupJobs/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Backup Jobs", + "operation": "Backup Job Object", + "description": "Get Job details" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/register/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "Register Resource Provider", + "description": "Registers subscription for given Resource Provider" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/unregister/action", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "Unregister Resource Provider", + "description": "Unregisters subscription for given Resource Provider" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataProtection/operations/read", + "display": { + "provider": "Microsoft.DataProtection", + "resource": "Resource Provider Operation", + "operation": "List of Operations", + "description": "Operation returns the list of Operations for a Resource Provider" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json new file mode 100644 index 000000000000..9fa00b05ece0 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/CreateOrUpdateBackupPolicy.json @@ -0,0 +1,200 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "backupPolicyName": "OSSDBPolicy", + "api-version": "2023-04-01-preview", + "parameters": { + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy", + "name": "OSSDBPolicy", + "type": "Microsoft.DataProtection/backupVaults/backupPolicies", + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default", + "id": "Default_" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly", + "id": "Weekly_" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/DeleteBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/DeleteBackupPolicy.json new file mode 100644 index 000000000000..d2a0eb3e82bf --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/DeleteBackupPolicy.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "backupPolicyName": "OSSDBPolicy", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/GetBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/GetBackupPolicy.json new file mode 100644 index 000000000000..0f7186d75c84 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/GetBackupPolicy.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "backupPolicyName": "OSSDBPolicy", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy", + "name": "OSSDBPolicy", + "type": "Microsoft.DataProtection/backupVaults/backupPolicies", + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default", + "id": "Default_" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly", + "id": "Weekly_" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/ListBackupPolicy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/ListBackupPolicy.json new file mode 100644 index 000000000000..492355518360 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/PolicyCRUD/ListBackupPolicy.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "000pikumar", + "vaultName": "PrivatePreviewVault", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/000pikumar/providers/Microsoft.DataProtection/backupVaults/PrivatePreviewVault/backupPolicies/OSSDBPolicy", + "name": "OSSDBPolicy", + "type": "Microsoft.DataProtection/backupVaults/backupPolicies", + "properties": { + "policyRules": [ + { + "backupParameters": { + "backupType": "Full", + "objectType": "AzureBackupParams" + }, + "trigger": { + "schedule": { + "repeatingTimeIntervals": [ + "R/2019-11-20T08:00:00-08:00/P1W" + ] + }, + "taggingCriteria": [ + { + "tagInfo": { + "tagName": "Default", + "id": "Default_" + }, + "taggingPriority": 99, + "isDefault": true + }, + { + "tagInfo": { + "tagName": "Weekly", + "id": "Weekly_" + }, + "taggingPriority": 20, + "isDefault": false, + "criteria": [ + { + "scheduleTimes": [ + "2019-03-01T13:00:00Z" + ], + "daysOfTheWeek": [ + "Sunday" + ], + "objectType": "ScheduleBasedBackupCriteria" + } + ] + } + ], + "objectType": "ScheduleBasedTriggerContext" + }, + "dataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "name": "BackupWeekly", + "objectType": "AzureBackupRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P1W" + } + } + ], + "isDefault": true, + "name": "Default", + "objectType": "AzureRetentionRule" + }, + { + "lifecycles": [ + { + "sourceDataStore": { + "dataStoreType": "VaultStore", + "objectType": "DataStoreInfoBase" + }, + "deleteAfter": { + "objectType": "AbsoluteDeleteOption", + "duration": "P12W" + } + } + ], + "isDefault": false, + "name": "Weekly", + "objectType": "AzureRetentionRule" + } + ], + "datasourceTypes": [ + "OssDB" + ], + "objectType": "BackupPolicy" + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/DeleteResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/DeleteResourceGuard.json new file mode 100644 index 000000000000..a6edb7799266 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/DeleteResourceGuard.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json new file mode 100644 index 000000000000..d485830b49f0 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultBackupSecurityPINRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json new file mode 100644 index 000000000000..d3007e7ca21e --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteProtectedItemRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json new file mode 100644 index 000000000000..5838c6dec3d7 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDeleteResourceGuardProxyRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json new file mode 100644 index 000000000000..65673e5a0258 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultDisableSoftDeleteRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json new file mode 100644 index 000000000000..d16ff7ab69e9 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectedItemRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json new file mode 100644 index 000000000000..dc72f3332822 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetDefaultUpdateProtectionPolicyRequests.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "requestName": "default", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuard.json new file mode 100644 index 000000000000..4c3e9864b991 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuard.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "ResourceGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation", + "vaultCriticalOperationExclusionList": [] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json new file mode 100644 index 000000000000..e061e884475d --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInResourceGroup.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "VaultGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation", + "vaultCriticalOperationExclusionList": [] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json new file mode 100644 index 000000000000..346a7f7b2078 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/GetResourceGuardsInSubscription.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "VaultGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation", + "vaultCriticalOperationExclusionList": [] + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json new file mode 100644 index 000000000000..c17babf184ae --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListBackupSecurityPINRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/getBackupSecurityPINRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/getBackupSecurityPINRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json new file mode 100644 index 000000000000..c03435b27363 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDeleteProtectedItemRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteProtectedItemRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/deleteProtectedItemRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json new file mode 100644 index 000000000000..72ec5ca4161e --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDeleteResourceGuardProxyRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/deleteResourceGuardProxyRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json new file mode 100644 index 000000000000..78a342adcd70 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListDisableSoftDeleteRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/disableSoftDeleteRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json new file mode 100644 index 000000000000..74809ce1e2a0 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectedItemRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectedItemRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/updateProtectedItemRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json new file mode 100644 index 000000000000..3c4c3d6a209e --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/ListUpdateProtectionPolicyRequests.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriotions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/resourceGuards/swaggerExample/updateProtectionPolicyRequests/default", + "name": "default", + "type": "Microsoft.DataProtection/resourceGuards/updateProtectionPolicyRequests" + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/PatchResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/PatchResourceGuard.json new file mode 100644 index 000000000000..5ce7a73abef8 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/PatchResourceGuard.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2023-04-01-preview", + "parameters": { + "tags": { + "newKey": "newVal" + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "VaultGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/PutResourceGuard.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/PutResourceGuard.json new file mode 100644 index 000000000000..3cd66676f36d --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardCRUD/PutResourceGuard.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardsName": "swaggerExample", + "api-version": "2023-04-01-preview", + "parameters": { + "location": "WestUS", + "tags": { + "key1": "val1" + } + } + }, + "responses": { + "200": { + "body": { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "VaultGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation", + "vaultCriticalOperationExclusionList": [] + } + } + }, + "201": { + "body": { + "location": "eastus", + "tags": { + "TestKey": "TestValue" + }, + "id": "/subscriptions/c999d45b-944f-418c-a0d8-c3fcfd1802c8/resourceGroups/vaultguardRGNew/providers/Microsoft.DataProtection/resourceGuards/VaultGuardTestNew", + "name": "VaultGuardTestNew", + "type": "Microsoft.DataProtection/resourceGuards", + "properties": { + "provisioningState": "Succeeded", + "allowAutoApprovals": true, + "resourceGuardOperations": [ + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupResourceGuardProxies/delete", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/deleteResourceGuardProxyRequests" + }, + { + "vaultCriticalOperation": "Microsoft.RecoveryServices/vaults/backupconfig/write", + "requestResourceType": "Microsoft.DataProtection/resourceGuards/disableSoftDeleteRequests" + } + ], + "description": "Please take JIT access before performing any of the critical operation", + "vaultCriticalOperationExclusionList": [] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json new file mode 100644 index 000000000000..b667d5af09e5 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/DeleteResourceGuardProxy.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7", + "vaultName": "sampleVault", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardProxyName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json new file mode 100644 index 000000000000..d42138e98f55 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/GetResourceGuardProxy.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7", + "vaultName": "sampleVault", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardProxyName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/vaults/backupResourceGuardProxies", + "properties": { + "resourceGuardResourceId": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource", + "resourceGuardOperationDetails": [ + { + "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupInstances/delete", + "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default" + }, + { + "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete", + "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteResourceGuardProxyRequests/default" + } + ], + "lastUpdatedTime": "2022-09-16T11:44:37.6130487Z", + "description": "Please take JIT access before performing any of the critical operation" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json new file mode 100644 index 000000000000..b4e33592bdd5 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/ListResourceGuardProxy.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7", + "vaultName": "sampleVault", + "resourceGroupName": "SampleResourceGroup", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/vaults/backupResourceGuardProxies", + "properties": { + "resourceGuardResourceId": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource", + "resourceGuardOperationDetails": [ + { + "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupInstances/delete", + "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default" + }, + { + "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete", + "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteResourceGuardProxyRequests/default" + } + ], + "lastUpdatedTime": "2022-09-16T11:44:37.6130487Z", + "description": "Please take JIT access before performing any of the critical operation" + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json new file mode 100644 index 000000000000..5a526703e3d1 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/PutResourceGuardProxy.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7", + "vaultName": "sampleVault", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardProxyName": "swaggerExample", + "api-version": "2023-04-01-preview", + "parameters": { + "properties": { + "resourceGuardResourceId": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupResourceGuardProxies/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/vaults/backupResourceGuardProxies", + "properties": { + "resourceGuardResourceId": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource", + "resourceGuardOperationDetails": [ + { + "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupInstances/delete", + "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default" + }, + { + "vaultCriticalOperation": "Microsoft.DataProtection/backupVaults/backupResourceGuardProxies/delete", + "defaultResourceRequest": "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteResourceGuardProxyRequests/default" + } + ], + "lastUpdatedTime": "2022-09-16T11:44:37.6130487Z", + "description": "Please take JIT access before performing any of the critical operation" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json new file mode 100644 index 000000000000..e1f399568aa2 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/ResourceGuardProxyCRUD/UnlockDeleteResourceGuardProxy.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "5e13b949-1218-4d18-8b99-7e12155ec4f7", + "vaultName": "sampleVault", + "resourceGroupName": "SampleResourceGroup", + "resourceGuardProxyName": "swaggerExample", + "api-version": "2023-04-01-preview", + "parameters": { + "resourceGuardOperationRequests": [ + "/subscriptions/f9e67185-f313-4e79-aa71-6458d429369d/resourceGroups/ResourceGuardSecurityAdminRG/providers/Microsoft.DataProtection/resourceGuards/ResourceGuardTestResource/deleteBackupInstanceRequests/default" + ], + "resourceToBeDeleted": "/subscriptions/5e13b949-1218-4d18-8b99-7e12155ec4f7/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/sampleVault/backupInstances/TestBI9779f4de" + } + }, + "responses": { + "200": { + "body": { + "unlockDeleteExpiryTime": "2022-09-16T12:50:10.7039695Z" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json new file mode 100644 index 000000000000..3b3c6ce26010 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/CheckBackupVaultsNameAvailability.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "location": "westus", + "api-version": "2023-04-01-preview", + "parameters": { + "type": "Microsoft.DataProtection/BackupVaults", + "name": "swaggerExample" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/DeleteBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/DeleteBackupVault.json new file mode 100644 index 000000000000..8ff213d06ed6 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/DeleteBackupVault.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVault.json new file mode 100644 index 000000000000..19cdbe70c7f5 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVault.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "monitoringSettings": { + "azureMonitorAlertSettings": { + "alertsForAllJobFailures": "Enabled" + } + }, + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + }, + "secureScore": "Adequate" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultWithMSI.json new file mode 100644 index 000000000000..68fd90e63b32 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultWithMSI.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "identity": { + "principalId": "c009b9a0-0024-417c-83cd-025d3776045d", + "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "type": "SystemAssigned" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + }, + "secureScore": "Adequate" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json new file mode 100644 index 000000000000..b672583a6fd9 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultsInResourceGroup.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1", + "name": "ExampleVault1", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + }, + "secureScore": "Adequate" + } + }, + { + "identity": { + "principalId": "c009b9a0-0024-417c-83cd-025d3776045d", + "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "type": "SystemAssigned" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2", + "name": "ExampleVault2", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "monitoringSettings": { + "azureMonitorAlertSettings": { + "alertsForAllJobFailures": "Enabled" + } + }, + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + }, + "secureScore": "Adequate" + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultsInSubscription.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultsInSubscription.json new file mode 100644 index 000000000000..8f7d73d7cf7c --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetBackupVaultsInSubscription.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup2/providers/Microsoft.DataProtection/BackupVaults/ExampleVault1", + "name": "ExampleVault1", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + }, + "secureScore": "Adequate" + } + }, + { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/BackupVaults/ExampleVault2", + "name": "ExampleVault2", + "type": "Microsoft.DataProtection/BackupVaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + }, + "secureScore": "Adequate" + } + } + ] + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetOperationResultPatch.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetOperationResultPatch.json new file mode 100644 index 000000000000..87ee382ef2a2 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/GetOperationResultPatch.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "04cf684a-d41f-4550-9f70-7708a3a2283b", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "api-version": "2023-04-01-preview" + }, + "responses": { + "200": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview" + }, + "body": { + "identity": { + "type": "None" + }, + "id": "/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + }, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/backupVaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview", + "Retry-After": "60" + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PatchBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PatchBackupVault.json new file mode 100644 index 000000000000..44234167afec --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PatchBackupVault.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2023-04-01-preview", + "operationId": "YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==", + "parameters": { + "tags": { + "newKey": "newVal" + }, + "properties": { + "monitoringSettings": { + "azureMonitorAlertSettings": { + "alertsForAllJobFailures": "Enabled" + } + } + } + } + }, + "responses": { + "202": { + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview", + "Location": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationResults/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview" + } + }, + "200": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "newKey": "newVal" + }, + "properties": { + "monitoringSettings": { + "azureMonitorAlertSettings": { + "alertsForAllJobFailures": "Enabled" + } + }, + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ] + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PutBackupVault.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PutBackupVault.json new file mode 100644 index 000000000000..0bde50a1c086 --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PutBackupVault.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2023-04-01-preview", + "parameters": { + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "identity": { + "type": "None" + }, + "properties": { + "monitoringSettings": { + "azureMonitorAlertSettings": { + "alertsForAllJobFailures": "Enabled" + } + }, + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "monitoringSettings": { + "azureMonitorAlertSettings": { + "alertsForAllJobFailures": "Enabled" + } + }, + "provisioningState": "Provisioning", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + } + } + }, + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview" + } + }, + "200": { + "body": { + "identity": { + "type": "None" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "monitoringSettings": { + "azureMonitorAlertSettings": { + "alertsForAllJobFailures": "Enabled" + } + }, + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + }, + "secureScore": "Adequate" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PutBackupVaultWithMSI.json b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PutBackupVaultWithMSI.json new file mode 100644 index 000000000000..d80e0ac153fc --- /dev/null +++ b/specification/dataprotection/resource-manager/Microsoft.DataProtection/preview/2023-04-01-preview/examples/VaultCRUD/PutBackupVaultWithMSI.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "subscriptionId": "0b352192-dcac-4cc7-992e-a96190ccc68c", + "resourceGroupName": "SampleResourceGroup", + "vaultName": "swaggerExample", + "api-version": "2023-04-01-preview", + "parameters": { + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "identity": { + "type": "systemAssigned" + }, + "properties": { + "monitoringSettings": { + "azureMonitorAlertSettings": { + "alertsForAllJobFailures": "Enabled" + } + }, + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "monitoringSettings": { + "azureMonitorAlertSettings": { + "alertsForAllJobFailures": "Enabled" + } + }, + "provisioningState": "Provisioning", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + } + } + }, + "headers": { + "Retry-After": "10", + "Azure-AsyncOperation": "https://management.windowsazure.com/subscriptions/04cf684a-d41f-4550-9f70-7708a3a2283b/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample/operationStatus/YWUzNDFkMzQtZmM5OS00MmUyLWEzNDMtZGJkMDIxZjlmZjgzOzdmYzBiMzhmLTc2NmItNDM5NS05OWQ1LTVmOGEzNzg4MWQzNA==?api-version=2023-04-01-preview" + } + }, + "200": { + "body": { + "identity": { + "principalId": "c009b9a0-0024-417c-83cd-025d3776045d", + "tenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "type": "SystemAssigned" + }, + "id": "/subscriptions/0b352192-dcac-4cc7-992e-a96190ccc68c/resourceGroups/SampleResourceGroup/providers/Microsoft.DataProtection/Backupvaults/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.DataProtection/Backupvaults", + "location": "WestUS", + "tags": { + "key1": "val1" + }, + "properties": { + "monitoringSettings": { + "azureMonitorAlertSettings": { + "alertsForAllJobFailures": "Enabled" + } + }, + "provisioningState": "Succeeded", + "storageSettings": [ + { + "datastoreType": "VaultStore", + "type": "LocallyRedundant" + } + ], + "featureSettings": { + "crossRegionRestoreSettings": { + "state": "Enabled" + } + }, + "securitySettings": { + "softDeleteSettings": { + "state": "Enabled", + "retentionDurationInDays": 14 + } + }, + "secureScore": "Adequate" + } + } + } + } +} diff --git a/specification/dataprotection/resource-manager/readme.md b/specification/dataprotection/resource-manager/readme.md index 536b4eb1e36e..aaaa89a9e534 100644 --- a/specification/dataprotection/resource-manager/readme.md +++ b/specification/dataprotection/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the DataProtection API. title: Data Protection Client description: Open API 2.0 Specs for Azure Data Protection service openapi-type: arm -tag: package-2023-01 +tag: package-preview-2023-04 csharp-sdks-folder: ./Generated/CSharp python-sdks-folder: ./Generated/Python go-sdk-folder: ./Generated/Golang @@ -46,6 +46,15 @@ semantic-validator: true message-format: json ``` + +### Tag: package-preview-2023-04 + +These settings apply only when `--tag=package-preview-2023-04` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-04' +input-file: + - Microsoft.DataProtection/preview/2023-04-01-preview/dataprotection.json +``` ### Tag: package-2023-01 These settings apply only when `--tag=package-2023-01` is specified on the command line. @@ -68,7 +77,7 @@ input-file: These settings apply only when `--tag=package-preview-2022-11` is specified on the command line. -```yaml $(tag) == 'package-preview-2022-11' +``` yaml $(tag) == 'package-preview-2022-11' input-file: - Microsoft.DataProtection/preview/2022-11-01-preview/dataprotection.json ``` From a33ea80072135171cc12a6edf13e4fbc24c5827c Mon Sep 17 00:00:00 2001 From: Jingshu923 <52914166+Jingshu923@users.noreply.github.com> Date: Wed, 10 May 2023 03:57:22 +0800 Subject: [PATCH 53/79] mongoDbAtlas Swagger Update (#23870) --- .../stable/2020-12-01/entityTypes/LinkedService.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json index 9673079b0d91..620db9a5b8c6 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json @@ -2175,6 +2175,10 @@ "database": { "type": "object", "description": "The name of the MongoDB Atlas database that you want to access. Type: string (or Expression with resultType string)." + }, + "mongoDbAtlasDriverVersion": { + "type": "object", + "description": "The MongoDB Atlas Driver version that you want to choose. Allowed value are 2.10.4 and 2.19.0. Type: string (or Expression with resultType string)." } }, "required": [ From 69df3c5d425f59599fa3cebd14e9843d5b82a91f Mon Sep 17 00:00:00 2001 From: Konrad Jamrozik Date: Tue, 9 May 2023 15:01:34 -0700 Subject: [PATCH 54/79] Improve prettier instructions: add `npx tsc`. (#23867) --- documentation/ci-fix.md | 29 +++++++++++++++++++++++++---- 1 file changed, 25 insertions(+), 4 deletions(-) diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index e00f0be43a3f..4feb8a872f3d 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -2,26 +2,46 @@ Here are guides to fix some of the CI failure. +## Prerequisites + +Most guides here require for you to have `npm` installed, which you can get by installing [Node.js](https://nodejs.org/en/download). + ## Spell check Please add your words to `./custom-words.txt` if you think you have the correct spell. -If your problem is some existing error name that is not a word and need to supress the error in that file (and don't want to add to custom-words.txt), you can add it to `./cSpell.txt`. +If your problem is some existing error name that is not a word and need to suppress the error in that file (and don't want to add to custom-words.txt), you can add it to `./cSpell.txt`. ## Prettier check +First, ensure you have fulfilled `Prerequisites` as explained above. + To update all the spec files for a given service run the following: ``` -# To fix a particular service swagger cd to that directory like +# To fix all the files in the repo run from the root of the repo +cd + +# OPTIONAL STEP: To fix a particular service swagger cd to that directory like cd specification/contosowidgetmanager -# to fix all the files in the repo run from the root of the repo + +# Install the dependencies to the local 'node_modules' folder. npm install -npx prettier -w **/*.json + +# Compile TypeScript. Compilation will fail, this is expected. But it will compile 'scripts/prettier-swagger-plugin', which is what we need. +npx tsc + +# Run 'prettier --list-different' to understand what is the problem. +npx prettier --list-different **/*.json + +# Run 'prettier --write' to fix the problem. +npx prettier --write **/*.json ``` Then please commit and push changes made by prettier. +Reference: [prettier](https://www.npmjs.com/package/prettier). + ## Model Validation Run Model Validation locally: @@ -35,6 +55,7 @@ Refer to [Semantic and Model Violations Reference](https://github.com/Azure/azur Refer to [Swagger-Example-Generation](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/393/Swagger-Example-Generation) for example automatic generation. ## Semantic Validation + Run Semantic Validation locally: ``` npm install -g oav From 07be669ac8e83c8766f10e99c59dbd2375614776 Mon Sep 17 00:00:00 2001 From: emmeliaAra Date: Wed, 10 May 2023 02:43:23 +0100 Subject: [PATCH 55/79] =?UTF-8?q?Added=20origin=20property=20to=20Dedicate?= =?UTF-8?q?dHsmOperation=20to=20resolve=20swagger=20cor=E2=80=A6=20(#23712?= =?UTF-8?q?)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Added origin property to DedicatedHsmOperation to resolve swagger correctness issue * update old api version in examples and added header property for operations annotated with x-ms-long-running-operation:true * fix api version --- .../stable/2021-11-30/dedicatedhsm.json | 4 ++++ .../2021-11-30/examples/DedicatedHsm_CreateOrUpdate.json | 2 +- .../stable/2021-11-30/examples/DedicatedHsm_Delete.json | 8 ++++++-- .../stable/2021-11-30/examples/DedicatedHsm_Get.json | 2 +- .../examples/DedicatedHsm_ListByResourceGroup.json | 2 +- .../examples/DedicatedHsm_ListBySubscription.json | 2 +- .../2021-11-30/examples/DedicatedHsm_OperationsList.json | 3 ++- .../stable/2021-11-30/examples/DedicatedHsm_Update.json | 2 +- .../PaymentHsm_Get_With_2018-10-31Preview_Version.json | 2 +- .../2021-11-30/examples/PaymentHsm_OperationsList.json | 1 + 10 files changed, 19 insertions(+), 9 deletions(-) diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json index acd58543c58d..5cae626b2c57 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/dedicatedhsm.json @@ -489,6 +489,10 @@ "type": "boolean", "readOnly": true }, + "origin": { + "description": "The origin of the operation", + "type": "string" + }, "display": { "properties": { "provider": { diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_CreateOrUpdate.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_CreateOrUpdate.json index 37cbb4664d7b..c73c89cd5cdb 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_CreateOrUpdate.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_CreateOrUpdate.json @@ -3,7 +3,7 @@ "resourceGroupName": "hsm-group", "name": "hsm1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-10-31-preview", + "api-version": "2021-11-30", "parameters": { "properties": { "networkProfile": { diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Delete.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Delete.json index a3b2a5432755..a1cfc53804db 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Delete.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Delete.json @@ -3,11 +3,15 @@ "resourceGroupName": "hsm-group", "name": "hsm1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-10-31-preview" + "api-version": "2021-11-30" }, "responses": { "200": {}, - "202": {}, + "202": { + "headers": { + "location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rgdedicatedhsm/providers/Microsoft.HardwareSecurityModules/dedicatedHSMs/dhsm1/" + } + }, "204": {} } } diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Get.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Get.json index 661d042e750a..4a61b26b2a0b 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Get.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Get.json @@ -3,7 +3,7 @@ "resourceGroupName": "hsm-group", "name": "hsm1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-10-31-preview" + "api-version": "2021-11-30" }, "responses": { "200": { diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_ListByResourceGroup.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_ListByResourceGroup.json index b343a4345a8a..f9c698b1fd30 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_ListByResourceGroup.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_ListByResourceGroup.json @@ -2,7 +2,7 @@ "parameters": { "resourceGroupName": "hsm-group", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-10-31-preview" + "api-version": "2021-11-30" }, "responses": { "200": { diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_ListBySubscription.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_ListBySubscription.json index d5268cb396e4..6af4d1f0ffb7 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_ListBySubscription.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_ListBySubscription.json @@ -1,7 +1,7 @@ { "parameters": { "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-10-31-preview" + "api-version": "2021-11-30" }, "responses": { "200": { diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_OperationsList.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_OperationsList.json index d918ea01706b..ab78e67c9a63 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_OperationsList.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_OperationsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2018-10-31-preview" + "api-version": "2021-11-30" }, "responses": { "200": { @@ -9,6 +9,7 @@ { "name": "hsm1", "isDataAction": false, + "origin": "system", "display": { "provider": "Microsoft HardwareSecurityModules", "resource": "Dedicated HSM", diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Update.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Update.json index 18a78b7a583c..c23383ca0a84 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Update.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/DedicatedHsm_Update.json @@ -3,7 +3,7 @@ "resourceGroupName": "hsm-group", "name": "hsm1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-10-31-preview", + "api-version": "2021-11-30", "parameters": { "tags": { "Dept": "hsm", diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/PaymentHsm_Get_With_2018-10-31Preview_Version.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/PaymentHsm_Get_With_2018-10-31Preview_Version.json index f7499afe8fb9..16dee823d013 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/PaymentHsm_Get_With_2018-10-31Preview_Version.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/PaymentHsm_Get_With_2018-10-31Preview_Version.json @@ -3,7 +3,7 @@ "resourceGroupName": "hsm-group", "name": "hsm1", "subscriptionId": "00000000-0000-0000-0000-000000000000", - "api-version": "2018-10-31-preview" + "api-version": "2021-11-30" }, "responses": { "200": { diff --git a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/PaymentHsm_OperationsList.json b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/PaymentHsm_OperationsList.json index 1e5242f51be2..ab78e67c9a63 100644 --- a/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/PaymentHsm_OperationsList.json +++ b/specification/hardwaresecuritymodules/resource-manager/Microsoft.HardwareSecurityModules/stable/2021-11-30/examples/PaymentHsm_OperationsList.json @@ -9,6 +9,7 @@ { "name": "hsm1", "isDataAction": false, + "origin": "system", "display": { "provider": "Microsoft HardwareSecurityModules", "resource": "Dedicated HSM", From fc0f00b52e3cebb52928e163ce0cc565fb75015d Mon Sep 17 00:00:00 2001 From: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Date: Wed, 10 May 2023 11:39:55 +0800 Subject: [PATCH 56/79] update links to avoid broken link (#23872) * update links to avoid broken link * fix modelvalidation * fix modelvalidation * update files * update files * update files * update files * update files * update files * update files * update files --- .../2022-08-01-preview/common-types.json | 2 +- .../2022-08-01-preview/costmanagement.json | 4 ++-- .../examples/BillingAccountAlerts.json | 2 +- .../examples/BillingAccountDimensionsList.json | 2 +- ...llingAccountDimensionsListExpandAndTop.json | 2 +- ...BillingAccountDimensionsListWithFilter.json | 4 ++-- .../examples/BillingAccountForecast.json | 4 ++-- .../examples/BillingAccountQuery.json | 4 ++-- .../examples/BillingAccountQueryGrouping.json | 4 ++-- .../examples/BillingProfileAlerts.json | 2 +- .../examples/BillingProfileForecast.json | 4 ++-- .../examples/DepartmentAlerts.json | 2 +- .../examples/DepartmentDimensionsList.json | 2 +- .../DepartmentDimensionsListExpandAndTop.json | 2 +- .../DepartmentDimensionsListWithFilter.json | 4 ++-- .../examples/DepartmentForecast.json | 4 ++-- .../examples/DepartmentQuery.json | 4 ++-- .../examples/DepartmentQueryGrouping.json | 4 ++-- .../examples/DismissResourceGroupAlerts.json | 2 +- .../examples/DismissSubscriptionAlerts.json | 2 +- .../examples/EnrollmentAccountAlerts.json | 2 +- .../EnrollmentAccountDimensionsList.json | 2 +- ...lmentAccountDimensionsListExpandAndTop.json | 2 +- ...ollmentAccountDimensionsListWithFilter.json | 4 ++-- .../examples/EnrollmentAccountForecast.json | 4 ++-- .../examples/EnrollmentAccountQuery.json | 4 ++-- .../EnrollmentAccountQueryGrouping.json | 4 ++-- .../examples/ExternalBillingAccountAlerts.json | 2 +- .../ExternalBillingAccountForecast.json | 2 +- .../ExternalBillingAccountsDimensions.json | 2 +- .../examples/ExternalBillingAccountsQuery.json | 2 +- .../examples/ExternalSubscriptionAlerts.json | 2 +- .../examples/ExternalSubscriptionForecast.json | 2 +- .../ExternalSubscriptionsDimensions.json | 2 +- .../examples/ExternalSubscriptionsQuery.json | 2 +- ...servationDetailsReportByBillingAccount.json | 4 ++-- ...servationDetailsReportByBillingProfile.json | 4 ++-- .../examples/InvoiceSectionAlerts.json | 2 +- .../examples/InvoiceSectionForecast.json | 4 ++-- .../MCABillingAccountDimensionsList.json | 18 +++++++++--------- ...llingAccountDimensionsListExpandAndTop.json | 18 +++++++++--------- ...BillingAccountDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCABillingAccountQuery.json | 4 ++-- .../MCABillingAccountQueryGrouping.json | 4 ++-- .../MCABillingProfileDimensionsList.json | 18 +++++++++--------- ...llingProfileDimensionsListExpandAndTop.json | 18 +++++++++--------- ...BillingProfileDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCABillingProfileQuery.json | 4 ++-- .../MCABillingProfileQueryGrouping.json | 4 ++-- .../examples/MCACustomerDimensionsList.json | 18 +++++++++--------- .../MCACustomerDimensionsListExpandAndTop.json | 18 +++++++++--------- .../MCACustomerDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCACustomerQuery.json | 4 ++-- .../examples/MCACustomerQueryGrouping.json | 4 ++-- .../MCAInvoiceSectionDimensionsList.json | 18 +++++++++--------- ...voiceSectionDimensionsListExpandAndTop.json | 18 +++++++++--------- ...InvoiceSectionDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCAInvoiceSectionQuery.json | 4 ++-- .../MCAInvoiceSectionQueryGrouping.json | 4 ++-- .../ManagementGroupDimensionsList.json | 2 +- ...agementGroupDimensionsListExpandAndTop.json | 2 +- ...anagementGroupDimensionsListWithFilter.json | 4 ++-- .../examples/ManagementGroupQuery.json | 4 ++-- .../examples/ManagementGroupQueryGrouping.json | 4 ++-- .../examples/OperationList.json | 2 +- .../examples/PrivateView.json | 2 +- .../examples/PrivateViewCreateOrUpdate.json | 2 +- .../examples/PrivateViewDelete.json | 2 +- .../examples/PrivateViewList.json | 2 +- .../examples/ResourceGroupAlerts.json | 2 +- .../examples/ResourceGroupDimensionsList.json | 2 +- .../examples/ResourceGroupForecast.json | 2 +- .../examples/ResourceGroupQuery.json | 2 +- .../examples/ResourceGroupQueryGrouping.json | 2 +- .../examples/SingleResourceGroupAlert.json | 2 +- .../examples/SingleSubscriptionAlert.json | 2 +- .../examples/SubscriptionAlerts.json | 2 +- .../examples/SubscriptionDimensionsList.json | 2 +- .../examples/SubscriptionForecast.json | 2 +- .../examples/SubscriptionQuery.json | 2 +- .../examples/SubscriptionQueryGrouping.json | 2 +- .../examples/ViewByResourceGroup.json | 2 +- .../ViewCreateOrUpdateByResourceGroup.json | 2 +- .../examples/ViewDeleteByResourceGroup.json | 2 +- .../examples/ViewListByResourceGroup.json | 2 +- .../2022-10-01-preview/common-types.json | 2 +- .../2022-10-01-preview/costmanagement.json | 4 ++-- .../examples/BillingAccountAlerts.json | 2 +- .../examples/BillingAccountDimensionsList.json | 2 +- ...llingAccountDimensionsListExpandAndTop.json | 2 +- ...BillingAccountDimensionsListWithFilter.json | 4 ++-- .../examples/BillingAccountForecast.json | 4 ++-- .../examples/BillingAccountQuery.json | 4 ++-- .../examples/BillingAccountQueryGrouping.json | 4 ++-- .../examples/BillingProfileAlerts.json | 2 +- .../examples/BillingProfileForecast.json | 4 ++-- .../examples/DepartmentAlerts.json | 2 +- .../examples/DepartmentDimensionsList.json | 2 +- .../DepartmentDimensionsListExpandAndTop.json | 2 +- .../DepartmentDimensionsListWithFilter.json | 4 ++-- .../examples/DepartmentForecast.json | 4 ++-- .../examples/DepartmentQuery.json | 4 ++-- .../examples/DepartmentQueryGrouping.json | 4 ++-- .../examples/DismissResourceGroupAlerts.json | 2 +- .../examples/DismissSubscriptionAlerts.json | 2 +- .../examples/EnrollmentAccountAlerts.json | 2 +- .../EnrollmentAccountDimensionsList.json | 2 +- ...lmentAccountDimensionsListExpandAndTop.json | 2 +- ...ollmentAccountDimensionsListWithFilter.json | 4 ++-- .../examples/EnrollmentAccountForecast.json | 4 ++-- .../examples/EnrollmentAccountQuery.json | 4 ++-- .../EnrollmentAccountQueryGrouping.json | 4 ++-- .../examples/ExternalBillingAccountAlerts.json | 2 +- .../ExternalBillingAccountForecast.json | 2 +- .../ExternalBillingAccountsDimensions.json | 2 +- .../examples/ExternalBillingAccountsQuery.json | 2 +- .../examples/ExternalSubscriptionAlerts.json | 2 +- .../examples/ExternalSubscriptionForecast.json | 2 +- .../ExternalSubscriptionsDimensions.json | 2 +- .../examples/ExternalSubscriptionsQuery.json | 2 +- ...servationDetailsReportByBillingAccount.json | 4 ++-- ...servationDetailsReportByBillingProfile.json | 4 ++-- .../examples/InvoiceSectionAlerts.json | 2 +- .../examples/InvoiceSectionForecast.json | 4 ++-- .../MCABillingAccountDimensionsList.json | 18 +++++++++--------- ...llingAccountDimensionsListExpandAndTop.json | 18 +++++++++--------- ...BillingAccountDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCABillingAccountQuery.json | 4 ++-- .../MCABillingAccountQueryGrouping.json | 4 ++-- .../MCABillingProfileDimensionsList.json | 18 +++++++++--------- ...llingProfileDimensionsListExpandAndTop.json | 18 +++++++++--------- ...BillingProfileDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCABillingProfileQuery.json | 4 ++-- .../MCABillingProfileQueryGrouping.json | 4 ++-- .../examples/MCACustomerDimensionsList.json | 18 +++++++++--------- .../MCACustomerDimensionsListExpandAndTop.json | 18 +++++++++--------- .../MCACustomerDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCACustomerQuery.json | 4 ++-- .../examples/MCACustomerQueryGrouping.json | 4 ++-- .../MCAInvoiceSectionDimensionsList.json | 18 +++++++++--------- ...voiceSectionDimensionsListExpandAndTop.json | 18 +++++++++--------- ...InvoiceSectionDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCAInvoiceSectionQuery.json | 4 ++-- .../MCAInvoiceSectionQueryGrouping.json | 4 ++-- .../ManagementGroupDimensionsList.json | 2 +- ...agementGroupDimensionsListExpandAndTop.json | 2 +- ...anagementGroupDimensionsListWithFilter.json | 4 ++-- .../examples/ManagementGroupQuery.json | 4 ++-- .../examples/ManagementGroupQueryGrouping.json | 4 ++-- .../examples/OperationList.json | 2 +- .../examples/PrivateView.json | 2 +- .../examples/PrivateViewCreateOrUpdate.json | 2 +- .../examples/PrivateViewDelete.json | 2 +- .../examples/PrivateViewList.json | 2 +- .../examples/ResourceGroupAlerts.json | 2 +- .../examples/ResourceGroupDimensionsList.json | 2 +- .../examples/ResourceGroupForecast.json | 2 +- .../examples/ResourceGroupQuery.json | 2 +- .../examples/ResourceGroupQueryGrouping.json | 2 +- .../examples/SingleResourceGroupAlert.json | 2 +- .../examples/SingleSubscriptionAlert.json | 2 +- .../examples/SubscriptionAlerts.json | 2 +- .../examples/SubscriptionDimensionsList.json | 2 +- .../examples/SubscriptionForecast.json | 2 +- .../examples/SubscriptionQuery.json | 2 +- .../examples/SubscriptionQueryGrouping.json | 2 +- .../examples/ViewByResourceGroup.json | 2 +- .../ViewCreateOrUpdateByResourceGroup.json | 2 +- .../examples/ViewDeleteByResourceGroup.json | 2 +- .../examples/ViewListByResourceGroup.json | 2 +- .../2022-10-05-preview/costmanagement.json | 4 ++-- .../examples/BillingAccountAlerts.json | 2 +- .../examples/BillingAccountDimensionsList.json | 2 +- ...llingAccountDimensionsListExpandAndTop.json | 2 +- ...BillingAccountDimensionsListWithFilter.json | 4 ++-- .../examples/BillingAccountForecast.json | 4 ++-- .../examples/BillingAccountQuery.json | 4 ++-- .../examples/BillingAccountQueryGrouping.json | 4 ++-- .../examples/BillingProfileAlerts.json | 2 +- .../examples/BillingProfileForecast.json | 4 ++-- .../examples/DepartmentAlerts.json | 2 +- .../examples/DepartmentDimensionsList.json | 2 +- .../DepartmentDimensionsListExpandAndTop.json | 2 +- .../DepartmentDimensionsListWithFilter.json | 4 ++-- .../examples/DepartmentForecast.json | 4 ++-- .../examples/DepartmentQuery.json | 4 ++-- .../examples/DepartmentQueryGrouping.json | 4 ++-- .../examples/DismissResourceGroupAlerts.json | 2 +- .../examples/DismissSubscriptionAlerts.json | 2 +- .../examples/EnrollmentAccountAlerts.json | 2 +- .../EnrollmentAccountDimensionsList.json | 2 +- ...lmentAccountDimensionsListExpandAndTop.json | 2 +- ...ollmentAccountDimensionsListWithFilter.json | 4 ++-- .../examples/EnrollmentAccountForecast.json | 4 ++-- .../examples/EnrollmentAccountQuery.json | 4 ++-- .../EnrollmentAccountQueryGrouping.json | 4 ++-- .../examples/ExternalBillingAccountAlerts.json | 2 +- .../ExternalBillingAccountsDimensions.json | 2 +- .../examples/ExternalBillingAccountsQuery.json | 2 +- .../examples/ExternalSubscriptionAlerts.json | 2 +- .../examples/ExternalSubscriptionForecast.json | 2 +- .../ExternalSubscriptionsDimensions.json | 2 +- .../examples/ExternalSubscriptionsQuery.json | 2 +- ...servationDetailsReportByBillingAccount.json | 4 ++-- ...servationDetailsReportByBillingProfile.json | 4 ++-- .../examples/InvoiceSectionAlerts.json | 2 +- .../examples/InvoiceSectionForecast.json | 4 ++-- .../MCABillingAccountDimensionsList.json | 18 +++++++++--------- ...llingAccountDimensionsListExpandAndTop.json | 18 +++++++++--------- ...BillingAccountDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCABillingAccountQuery.json | 4 ++-- .../MCABillingAccountQueryGrouping.json | 4 ++-- .../MCABillingProfileDimensionsList.json | 18 +++++++++--------- ...llingProfileDimensionsListExpandAndTop.json | 18 +++++++++--------- ...BillingProfileDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCABillingProfileQuery.json | 4 ++-- .../MCABillingProfileQueryGrouping.json | 4 ++-- .../examples/MCACustomerDimensionsList.json | 18 +++++++++--------- .../MCACustomerDimensionsListExpandAndTop.json | 18 +++++++++--------- .../MCACustomerDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCACustomerQuery.json | 4 ++-- .../examples/MCACustomerQueryGrouping.json | 4 ++-- .../MCAInvoiceSectionDimensionsList.json | 18 +++++++++--------- ...voiceSectionDimensionsListExpandAndTop.json | 18 +++++++++--------- ...InvoiceSectionDimensionsListWithFilter.json | 12 ++++++------ .../examples/MCAInvoiceSectionQuery.json | 4 ++-- .../MCAInvoiceSectionQueryGrouping.json | 4 ++-- .../ManagementGroupDimensionsList.json | 2 +- ...agementGroupDimensionsListExpandAndTop.json | 2 +- ...anagementGroupDimensionsListWithFilter.json | 4 ++-- .../examples/ManagementGroupQuery.json | 4 ++-- .../examples/ManagementGroupQueryGrouping.json | 4 ++-- .../examples/OperationList.json | 2 +- .../examples/PrivateView.json | 2 +- .../examples/PrivateViewCreateOrUpdate.json | 2 +- .../examples/PrivateViewDelete.json | 2 +- .../examples/PrivateViewList.json | 2 +- .../examples/ResourceGroupAlerts.json | 2 +- .../examples/ResourceGroupDimensionsList.json | 2 +- .../examples/ResourceGroupForecast.json | 2 +- .../examples/ResourceGroupQuery.json | 2 +- .../examples/ResourceGroupQueryGrouping.json | 2 +- .../examples/SingleResourceGroupAlert.json | 2 +- .../examples/SingleSubscriptionAlert.json | 2 +- .../examples/SubscriptionAlerts.json | 2 +- .../examples/SubscriptionDimensionsList.json | 2 +- .../examples/SubscriptionForecast.json | 2 +- .../examples/SubscriptionQuery.json | 2 +- .../examples/SubscriptionQueryGrouping.json | 2 +- .../examples/ViewByResourceGroup.json | 2 +- .../ViewCreateOrUpdateByResourceGroup.json | 2 +- .../examples/ViewDeleteByResourceGroup.json | 2 +- .../examples/ViewListByResourceGroup.json | 2 +- .../2023-04-01-preview/costmanagement.json | 4 ++-- .../stable/2021-10-01/costmanagement.json | 4 ++-- .../examples/BillingAccountAlerts.json | 2 +- ...llingAccountDimensionsListExpandAndTop.json | 2 +- ...BillingAccountDimensionsListWithFilter.json | 4 ++-- .../examples/BillingProfileAlerts.json | 2 +- .../examples/BillingProfileForecast.json | 2 +- .../2021-10-01/examples/DepartmentAlerts.json | 2 +- .../DepartmentDimensionsListExpandAndTop.json | 2 +- .../DepartmentDimensionsListWithFilter.json | 4 ++-- .../examples/DismissResourceGroupAlerts.json | 2 +- .../examples/DismissSubscriptionAlerts.json | 2 +- .../examples/EnrollmentAccountAlerts.json | 2 +- ...lmentAccountDimensionsListExpandAndTop.json | 2 +- ...ollmentAccountDimensionsListWithFilter.json | 4 ++-- .../examples/ExternalBillingAccountAlerts.json | 2 +- .../examples/ExternalSubscriptionAlerts.json | 2 +- ...servationDetailsReportByBillingAccount.json | 4 ++-- ...servationDetailsReportByBillingProfile.json | 4 ++-- .../examples/InvoiceSectionAlerts.json | 2 +- .../examples/InvoiceSectionForecast.json | 2 +- .../MCABillingAccountDimensionsList.json | 12 ++++++------ ...llingAccountDimensionsListExpandAndTop.json | 14 +++++++------- ...BillingAccountDimensionsListWithFilter.json | 10 +++++----- .../MCABillingProfileDimensionsList.json | 12 ++++++------ ...llingProfileDimensionsListExpandAndTop.json | 14 +++++++------- ...BillingProfileDimensionsListWithFilter.json | 10 +++++----- .../examples/MCACustomerDimensionsList.json | 12 ++++++------ .../MCACustomerDimensionsListExpandAndTop.json | 14 +++++++------- .../MCACustomerDimensionsListWithFilter.json | 10 +++++----- .../MCAInvoiceSectionDimensionsList.json | 12 ++++++------ ...voiceSectionDimensionsListExpandAndTop.json | 14 +++++++------- ...InvoiceSectionDimensionsListWithFilter.json | 10 +++++----- ...agementGroupDimensionsListExpandAndTop.json | 2 +- ...anagementGroupDimensionsListWithFilter.json | 4 ++-- .../examples/ResourceGroupAlerts.json | 2 +- .../examples/ResourceGroupDimensionsList.json | 2 +- .../examples/SingleResourceGroupAlert.json | 2 +- .../examples/SingleSubscriptionAlert.json | 2 +- .../examples/SubscriptionAlerts.json | 2 +- .../examples/SubscriptionDimensionsList.json | 2 +- ...stmanagement.generatecostdetailsreport.json | 2 +- .../stable/2022-10-01/costmanagement.json | 4 ++-- 296 files changed, 701 insertions(+), 701 deletions(-) diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/common-types.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/common-types.json index 286119be63a9..d06bc0c2c99d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/common-types.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/common-types.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2021-10-01", + "version": "2022-08-01-preview", "title": "Cost Management common types" }, "paths": {}, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/costmanagement.json index 64ef875950fe..5b1272d3b87e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/costmanagement.json @@ -1129,7 +1129,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", - "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", + "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1192,7 +1192,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", - "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", + "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountAlerts.json index 92e85a187afc..63cc092f9fee 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsList.json index 3a0b12d378b4..96f4f43c0200 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "100", "scope": "providers/Microsoft.Billing/billingAccounts/100" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json index 34c0efbeedf4..6d9514877150 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "100", "$expand": "properties/data", "$top": 5, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsListWithFilter.json index 79382668a3d6..2337fbe64a8e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "100", "$expand": "properties/data", "$top": 5, @@ -30,7 +30,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-08-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountForecast.json index c930b012cc6c..cc118bb8977e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { @@ -57,7 +57,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountQuery.json index 7cb9e38ee05f..7d5b6d52e19b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "70664866", "scope": "providers/Microsoft.Billing/billingAccounts/70664866", "parameters": { @@ -55,7 +55,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountQueryGrouping.json index 88006102fe55..07c5dc423db2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingAccountQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "70664866", "scope": "providers/Microsoft.Billing/billingAccounts/70664866", "parameters": { @@ -30,7 +30,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingProfileAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingProfileAlerts.json index 62dc930b9a7f..bdb2dbc89356 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingProfileAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingProfileAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingProfileForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingProfileForecast.json index 967338b46cd4..7caf2282e3af 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingProfileForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/BillingProfileForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", @@ -58,7 +58,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentAlerts.json index a274d64fcd98..c28bcf5cf224 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsList.json index 041eeed53578..8829e570ad3b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "100", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsListExpandAndTop.json index e9d8435a14ba..4e58aa263eab 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "100", "departmentId": "123", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsListWithFilter.json index c30e2c6a89a9..a488dae61bad 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "100", "departmentId": "123", "$expand": "properties/data", @@ -31,7 +31,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-08-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentForecast.json index 23c5074f3e0c..f4ab7e66c067 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123", @@ -58,7 +58,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentQuery.json index 606fac536ecc..b50235f794e4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "70664866", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentQueryGrouping.json index ad8e4e324e7c..44efe17d04bb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DepartmentQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "70664866", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DismissResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DismissResourceGroupAlerts.json index 5cd608f81392..4062d0a411de 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DismissResourceGroupAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DismissResourceGroupAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DismissSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DismissSubscriptionAlerts.json index 863ac58f95b8..fecdb5315480 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DismissSubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/DismissSubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "alertId": "22222222-2222-2222-2222-222222222222", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountAlerts.json index 3a6b90445694..80be4e547b06 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsList.json index 4219114de7bd..84e3bbe13c62 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "100", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json index 0611011ef86b..622a664edb84 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "100", "enrollmentAccountId": "456", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json index 8d2f3a997657..61038eada401 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "100", "enrollmentAccountId": "456", "$expand": "properties/data", @@ -31,7 +31,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-08-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountForecast.json index 093ec2218244..dd1f0ca8008a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456", @@ -58,7 +58,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountQuery.json index 95c6cb59521f..c2e5ae5c22d5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "70664866", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountQueryGrouping.json index caa6d869a95f..3ecb866c66cb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/EnrollmentAccountQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "70664866", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountAlerts.json index d69d7a968e57..ef2589267733 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountForecast.json index 167367d188ab..0501448f3ec5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountsDimensions.json index 705d4fcd3fb4..ebf348817559 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountsDimensions.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountsDimensions.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountsQuery.json index b21025b0a41f..d8da018f84ae 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountsQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalBillingAccountsQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionAlerts.json index 92436a022d8f..1e77460b5a3a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionForecast.json index f651e5cec87a..90c92cc5a318 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionsDimensions.json index 7f2217ebf526..b18be0d55851 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionsDimensions.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionsDimensions.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionsQuery.json index b71101e08ff2..a7980632a766 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionsQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ExternalSubscriptionsQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json index d8c8f0f40faf..a843fb8c1879 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json @@ -3,12 +3,12 @@ "billingAccountId": "9845612", "startDate": "2020-01-01", "endDate": "2020-01-30", - "api-version": "2019-11-01" + "api-version": "2022-08-01-preview" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2022-08-01-preview", "Retry-After": "60" } }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json index a4bd203ef284..aaafbe4503f9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json @@ -4,12 +4,12 @@ "billingProfileId": "CZSFR-SDFXC-DSDF", "startDate": "2020-01-01", "endDate": "2020-01-30", - "api-version": "2019-11-01" + "api-version": "2022-08-01-preview" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2022-08-01-preview", "Retry-After": "60" } }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/InvoiceSectionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/InvoiceSectionAlerts.json index d90fc5a57b18..8efdf8303e43 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/InvoiceSectionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/InvoiceSectionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/InvoiceSectionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/InvoiceSectionForecast.json index 2b2bf5ee04c8..f161e8676d6f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/InvoiceSectionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/InvoiceSectionForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -59,7 +59,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsList.json index 7a30ed852d58..b873388d6b54 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, @@ -9,30 +9,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json index 12a93024cf15..268e5b76cbb5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "$expand": "properties/data", "$top": 5, @@ -11,8 +11,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -24,16 +24,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -45,8 +45,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json index f8c6a0ddb4b5..59bcf12be80e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "$expand": "properties/data", "$top": 5, @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,12 +25,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-08-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountQuery.json index dfd81bcbd7cd..542b0aad5f40 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { @@ -55,7 +55,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountQueryGrouping.json index 31f0ffbf4ad9..3b689a37fb50 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingAccountQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { @@ -30,7 +30,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsList.json index 61a209e80977..071bde9cbb66 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" @@ -10,30 +10,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json index fca61ffb8f2d..7fa3d97c388a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "$expand": "properties/data", @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,16 +25,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -46,8 +46,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json index 946a0fe6665d..2c03d7cdea6b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "$expand": "properties/data", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,12 +26,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-08-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileQuery.json index 90eff4558051..a3632f3d6a4f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileQueryGrouping.json index e110931544a8..2484a316f77c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCABillingProfileQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsList.json index d085114ab90d..8a32872b5153 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "customerId": "5678", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" @@ -10,30 +10,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json index 638b70eb595b..7d0aea19683b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "customerId": "5678", "$expand": "properties/data", @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,16 +25,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -46,8 +46,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsListWithFilter.json index 3ecc017c6f8e..cdcf0f9c1d77 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "customerId": "13579", "$expand": "properties/data", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,12 +26,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-08-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerQuery.json index a14f5498e0bf..89366c68ed11 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "customerId": "5678", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerQueryGrouping.json index a2da465d67e3..9362f4ddad3b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCACustomerQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "customerId": "5678", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsList.json index 529439b0acbf..dc2fa9598152 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -11,30 +11,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json index 4a1cca2dea2a..d2478213a2f3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,16 +26,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -47,8 +47,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json index 3d737cf438d1..98213d0eab9d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -14,8 +14,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2022-08-01-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-08-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -27,12 +27,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-08-01T00:00:00-07:00", + "usageEnd": "2022-08-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-08-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionQuery.json index 909f643e09a0..c8f05c734dde 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -57,7 +57,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionQueryGrouping.json index 8c4f73f459bf..5d256ad6b16a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/MCAInvoiceSectionQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -32,7 +32,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsList.json index 381dd37759c6..093e1ff2a953 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json index f0d980973533..e301b6dee0e7 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "managementGroupId": "MyMgId", "$expand": "properties/data", "$top": 5, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsListWithFilter.json index 121645f857ba..3e4787311fda 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "managementGroupId": "MyMgId", "$expand": "properties/data", "$top": 5, @@ -30,7 +30,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-08-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupQuery.json index a36839a00351..bf43c1b0b67b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId", "parameters": { @@ -55,7 +55,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupQueryGrouping.json index 6765ec668659..47f098c02d14 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ManagementGroupQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId", "parameters": { @@ -30,7 +30,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2022-08-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/OperationList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/OperationList.json index bb657778f56f..c935d949f013 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/OperationList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/OperationList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01" + "api-version": "2022-08-01-preview" }, "responses": { "200": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateView.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateView.json index 4c5a6ee3e54b..58d7c1419e60 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateView.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateView.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "viewName": "swaggerExample" }, "responses": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewCreateOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewCreateOrUpdate.json index 13fce4b9f5aa..2e30bf1038d3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewCreateOrUpdate.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewCreateOrUpdate.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "viewName": "swaggerExample", "parameters": { "eTag": "\"1d4ff9fe66f1d10\"", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewDelete.json index 3e6638272399..0f9fa1ed2003 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewDelete.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewDelete.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "viewName": "TestView" }, "responses": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewList.json index 6fc6bfdf7a68..de619b3832d6 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/PrivateViewList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01" + "api-version": "2022-08-01-preview" }, "responses": { "200": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupAlerts.json index d6b7e3e6eb4a..8cbdb6e0725a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupDimensionsList.json index b8f59b39981d..9547c09a23d4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "system.orlando", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupForecast.json index 20fd7ba2f22e..133001c8b974 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupQuery.json index fe2e639a90b7..c06d5bdc1bc3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupQueryGrouping.json index ec3b75e7a4fd..c3d8afbb07c5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ResourceGroupQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SingleResourceGroupAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SingleResourceGroupAlert.json index 0e43a5319f88..9773bbbdd283 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SingleResourceGroupAlert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SingleResourceGroupAlert.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SingleSubscriptionAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SingleSubscriptionAlert.json index 4c2a74b2f55c..bfc8718713d2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SingleSubscriptionAlert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SingleSubscriptionAlert.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "alertId": "22222222-2222-2222-2222-222222222222" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionAlerts.json index 76075cc1225c..851e2a956e35 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionDimensionsList.json index 7ea7c1d89059..96b898e12a36 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "$top": 5, "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionForecast.json index 47679e6bcdf7..0f99119ce2a0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionQuery.json index 23534733adf4..d6f6a7d3c729 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionQueryGrouping.json index 41803cc11041..6bc6734316fb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/SubscriptionQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewByResourceGroup.json index e6ad7bccb6db..046e0b48e576 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "viewName": "swaggerExample", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json index 797191b41bee..dd4fba056e00 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", "viewName": "swaggerExample", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewDeleteByResourceGroup.json index 2ebf54df8ad3..53207b9b151b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewDeleteByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewDeleteByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", "viewName": "TestView" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewListByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewListByResourceGroup.json index 6cbb6c7431b9..3c20eec4bb1c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewListByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-08-01-preview/examples/ViewListByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-08-01-preview", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" }, "responses": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/common-types.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/common-types.json index 286119be63a9..79b586a0b603 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/common-types.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/common-types.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2021-10-01", + "version": "2022-10-01-preview", "title": "Cost Management common types" }, "paths": {}, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/costmanagement.json index fc6b6a73a383..99d496af06bd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/costmanagement.json @@ -1129,7 +1129,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", - "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", + "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1192,7 +1192,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", - "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", + "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountAlerts.json index 92e85a187afc..ad77e9c0ef8d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsList.json index 3a0b12d378b4..37a677187de3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "100", "scope": "providers/Microsoft.Billing/billingAccounts/100" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json index 34c0efbeedf4..ce084452aa2b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "100", "$expand": "properties/data", "$top": 5, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsListWithFilter.json index 79382668a3d6..45739777058b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "100", "$expand": "properties/data", "$top": 5, @@ -30,7 +30,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountForecast.json index c930b012cc6c..1a7abe7506c1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { @@ -57,7 +57,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountQuery.json index 7cb9e38ee05f..0c0481fe21db 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "70664866", "scope": "providers/Microsoft.Billing/billingAccounts/70664866", "parameters": { @@ -55,7 +55,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountQueryGrouping.json index 88006102fe55..6a84d206bdfe 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingAccountQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "70664866", "scope": "providers/Microsoft.Billing/billingAccounts/70664866", "parameters": { @@ -30,7 +30,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingProfileAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingProfileAlerts.json index 62dc930b9a7f..146ae961ac57 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingProfileAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingProfileAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingProfileForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingProfileForecast.json index 967338b46cd4..e2794b5013f8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingProfileForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/BillingProfileForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", @@ -58,7 +58,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentAlerts.json index a274d64fcd98..3e1e7cd556c4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsList.json index 041eeed53578..e02dd51890d5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "100", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsListExpandAndTop.json index e9d8435a14ba..3661883cfd00 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "100", "departmentId": "123", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsListWithFilter.json index c30e2c6a89a9..7246a765fdc1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "100", "departmentId": "123", "$expand": "properties/data", @@ -31,7 +31,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentForecast.json index 23c5074f3e0c..4440bf897206 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123", @@ -58,7 +58,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentQuery.json index 606fac536ecc..b74fa93dad49 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "70664866", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentQueryGrouping.json index ad8e4e324e7c..1c86320d8774 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DepartmentQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "70664866", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DismissResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DismissResourceGroupAlerts.json index 5cd608f81392..19f85be4c14c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DismissResourceGroupAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DismissResourceGroupAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DismissSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DismissSubscriptionAlerts.json index 863ac58f95b8..b61bd7690e93 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DismissSubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/DismissSubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "alertId": "22222222-2222-2222-2222-222222222222", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountAlerts.json index 3a6b90445694..3dd1e8bd27a9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsList.json index 4219114de7bd..afbf273c5601 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "100", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json index 0611011ef86b..24c181bd7131 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "100", "enrollmentAccountId": "456", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json index 8d2f3a997657..443ba64eea47 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "100", "enrollmentAccountId": "456", "$expand": "properties/data", @@ -31,7 +31,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountForecast.json index 093ec2218244..d1b9945e5330 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456", @@ -58,7 +58,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountQuery.json index 95c6cb59521f..ef11ffad26f7 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "70664866", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountQueryGrouping.json index caa6d869a95f..f7a832f717ee 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/EnrollmentAccountQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "70664866", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountAlerts.json index d69d7a968e57..edb42b0d4389 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountForecast.json index 167367d188ab..f14844a2f7f5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountsDimensions.json index 705d4fcd3fb4..10386495044c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountsDimensions.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountsDimensions.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountsQuery.json index b21025b0a41f..a116194a0b67 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountsQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalBillingAccountsQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionAlerts.json index 92436a022d8f..153bdaeaa6e8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionForecast.json index f651e5cec87a..0e0028c5a964 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionsDimensions.json index 7f2217ebf526..68ea257d60a1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionsDimensions.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionsDimensions.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionsQuery.json index b71101e08ff2..3d98ae1a4e1b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionsQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ExternalSubscriptionsQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json index d8c8f0f40faf..fd31a37d61da 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/GenerateReservationDetailsReportByBillingAccount.json @@ -3,12 +3,12 @@ "billingAccountId": "9845612", "startDate": "2020-01-01", "endDate": "2020-01-30", - "api-version": "2019-11-01" + "api-version": "2022-10-01-preview" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2022-10-01-preview", "Retry-After": "60" } }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json index a4bd203ef284..df0dfd73d828 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/GenerateReservationDetailsReportByBillingProfile.json @@ -4,12 +4,12 @@ "billingProfileId": "CZSFR-SDFXC-DSDF", "startDate": "2020-01-01", "endDate": "2020-01-30", - "api-version": "2019-11-01" + "api-version": "2022-10-01-preview" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2022-10-01-preview", "Retry-After": "60" } }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/InvoiceSectionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/InvoiceSectionAlerts.json index d90fc5a57b18..a3dfc25a1e5e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/InvoiceSectionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/InvoiceSectionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/InvoiceSectionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/InvoiceSectionForecast.json index 2b2bf5ee04c8..189474001a3a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/InvoiceSectionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/InvoiceSectionForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -59,7 +59,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsList.json index 7a30ed852d58..91594415986e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, @@ -9,30 +9,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json index 12a93024cf15..f9e75c90e627 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "$expand": "properties/data", "$top": 5, @@ -11,8 +11,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -24,16 +24,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -45,8 +45,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json index f8c6a0ddb4b5..bc23c46ffaf9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "$expand": "properties/data", "$top": 5, @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,12 +25,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountQuery.json index dfd81bcbd7cd..c3b985dd1a83 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { @@ -55,7 +55,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountQueryGrouping.json index 31f0ffbf4ad9..49f3b1acc71f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingAccountQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { @@ -30,7 +30,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsList.json index 61a209e80977..d2a75beef1d5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" @@ -10,30 +10,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json index fca61ffb8f2d..aea6333458c9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "$expand": "properties/data", @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,16 +25,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -46,8 +46,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json index 946a0fe6665d..f56fdc65be9b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "$expand": "properties/data", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,12 +26,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileQuery.json index 90eff4558051..ce05a32b95fd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileQueryGrouping.json index e110931544a8..223020e2cf31 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCABillingProfileQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsList.json index d085114ab90d..3944bb9fbc71 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "customerId": "5678", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" @@ -10,30 +10,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json index 638b70eb595b..9abf3b6d17e2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "customerId": "5678", "$expand": "properties/data", @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,16 +25,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -46,8 +46,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsListWithFilter.json index 3ecc017c6f8e..2e4c6d02ca7c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "customerId": "13579", "$expand": "properties/data", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,12 +26,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerQuery.json index a14f5498e0bf..4b6e1a609e78 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "customerId": "5678", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerQueryGrouping.json index a2da465d67e3..80e134c58f80 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCACustomerQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "customerId": "5678", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsList.json index 529439b0acbf..3019bba8e7cd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -11,30 +11,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json index 4a1cca2dea2a..9c27d811b897 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,16 +26,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -47,8 +47,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json index 3d737cf438d1..2189b0c55310 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -14,8 +14,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2022-10-01-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-10-01-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -27,12 +27,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-01T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionQuery.json index 909f643e09a0..ee80a7315c05 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -57,7 +57,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionQueryGrouping.json index 8c4f73f459bf..a794edddaab8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/MCAInvoiceSectionQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -32,7 +32,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsList.json index 381dd37759c6..1daf90760745 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json index f0d980973533..8fb0971aff16 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "managementGroupId": "MyMgId", "$expand": "properties/data", "$top": 5, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsListWithFilter.json index 121645f857ba..d902d2f147f3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "managementGroupId": "MyMgId", "$expand": "properties/data", "$top": 5, @@ -30,7 +30,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-01-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupQuery.json index a36839a00351..d6f009b02d36 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId", "parameters": { @@ -55,7 +55,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupQueryGrouping.json index 6765ec668659..8dd18765ba59 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ManagementGroupQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId", "parameters": { @@ -30,7 +30,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2022-10-01-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/OperationList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/OperationList.json index bb657778f56f..985119b3bbe6 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/OperationList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/OperationList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01" + "api-version": "2022-10-01-preview" }, "responses": { "200": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateView.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateView.json index 4c5a6ee3e54b..2846b3e270de 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateView.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateView.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "viewName": "swaggerExample" }, "responses": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewCreateOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewCreateOrUpdate.json index 13fce4b9f5aa..7bb9295d31ea 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewCreateOrUpdate.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewCreateOrUpdate.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "viewName": "swaggerExample", "parameters": { "eTag": "\"1d4ff9fe66f1d10\"", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewDelete.json index 3e6638272399..d5fb6f70955c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewDelete.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewDelete.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "viewName": "TestView" }, "responses": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewList.json index 6fc6bfdf7a68..9d4dbb6d01ba 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/PrivateViewList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01" + "api-version": "2022-10-01-preview" }, "responses": { "200": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupAlerts.json index d6b7e3e6eb4a..810958b30464 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupDimensionsList.json index b8f59b39981d..d99cea2bc945 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "system.orlando", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupForecast.json index 20fd7ba2f22e..38d343d8d99c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupQuery.json index fe2e639a90b7..17288cd38946 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupQueryGrouping.json index ec3b75e7a4fd..4e4a73bf77e4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ResourceGroupQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SingleResourceGroupAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SingleResourceGroupAlert.json index 0e43a5319f88..403ad9d13ca7 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SingleResourceGroupAlert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SingleResourceGroupAlert.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SingleSubscriptionAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SingleSubscriptionAlert.json index 4c2a74b2f55c..bb3de757c67d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SingleSubscriptionAlert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SingleSubscriptionAlert.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "alertId": "22222222-2222-2222-2222-222222222222" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionAlerts.json index 76075cc1225c..ce52e0cf6c58 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionDimensionsList.json index 7ea7c1d89059..a090d34e75fa 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "$top": 5, "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionForecast.json index 47679e6bcdf7..0bc4098bcd3d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionQuery.json index 23534733adf4..487f2703182d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionQueryGrouping.json index 41803cc11041..5e25adff5b8d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/SubscriptionQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewByResourceGroup.json index e6ad7bccb6db..497e1a9811f5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "viewName": "swaggerExample", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json index 797191b41bee..d34f4a4fe813 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewCreateOrUpdateByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", "viewName": "swaggerExample", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewDeleteByResourceGroup.json index 2ebf54df8ad3..ab4aafd9ab14 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewDeleteByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewDeleteByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", "viewName": "TestView" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewListByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewListByResourceGroup.json index 6cbb6c7431b9..980be7289fc8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewListByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-01-preview/examples/ViewListByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-01-preview", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" }, "responses": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/costmanagement.json index b420ce8c3943..fbf24d23bab9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/costmanagement.json @@ -1129,7 +1129,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", - "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", + "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1192,7 +1192,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", - "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", + "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountAlerts.json index 92e85a187afc..d916ada9fbfb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsList.json index 3a0b12d378b4..663ae4d256a4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "100", "scope": "providers/Microsoft.Billing/billingAccounts/100" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsListExpandAndTop.json index 34c0efbeedf4..08337bc9f654 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "100", "$expand": "properties/data", "$top": 5, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsListWithFilter.json index 79382668a3d6..ddb82972cd2b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "100", "$expand": "properties/data", "$top": 5, @@ -30,7 +30,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-05-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountForecast.json index c930b012cc6c..a572c949b046 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { @@ -57,7 +57,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountQuery.json index 7cb9e38ee05f..ff0da03d3867 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "70664866", "scope": "providers/Microsoft.Billing/billingAccounts/70664866", "parameters": { @@ -55,7 +55,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountQueryGrouping.json index 88006102fe55..988c72602cbc 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingAccountQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "70664866", "scope": "providers/Microsoft.Billing/billingAccounts/70664866", "parameters": { @@ -30,7 +30,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingProfileAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingProfileAlerts.json index 62dc930b9a7f..efbc3223e4eb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingProfileAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingProfileAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingProfileForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingProfileForecast.json index 967338b46cd4..8ddf9592be17 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingProfileForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/BillingProfileForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", @@ -58,7 +58,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentAlerts.json index a274d64fcd98..2c8aea73d1d3 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsList.json index 041eeed53578..28a7f09b5c1c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "100", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsListExpandAndTop.json index e9d8435a14ba..6911e3079ca8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "100", "departmentId": "123", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsListWithFilter.json index c30e2c6a89a9..d565301f2a40 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "100", "departmentId": "123", "$expand": "properties/data", @@ -31,7 +31,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-05-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentForecast.json index 23c5074f3e0c..b27932af8aec 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123", @@ -58,7 +58,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentQuery.json index 606fac536ecc..c9bdd5fe15a8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "70664866", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentQueryGrouping.json index ad8e4e324e7c..203004214d1e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DepartmentQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "70664866", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DismissResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DismissResourceGroupAlerts.json index 5cd608f81392..aa239d308505 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DismissResourceGroupAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DismissResourceGroupAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DismissSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DismissSubscriptionAlerts.json index 863ac58f95b8..c5d4d6311789 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DismissSubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/DismissSubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "alertId": "22222222-2222-2222-2222-222222222222", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountAlerts.json index 3a6b90445694..f073919d4bfc 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsList.json index 4219114de7bd..492dd7cfe294 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "100", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json index 0611011ef86b..ee64b64fc58b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "100", "enrollmentAccountId": "456", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsListWithFilter.json index 8d2f3a997657..c58184554c2a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "100", "enrollmentAccountId": "456", "$expand": "properties/data", @@ -31,7 +31,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-05-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountForecast.json index 093ec2218244..6d8148b7ecac 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456", @@ -58,7 +58,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountQuery.json index 95c6cb59521f..f67c2d627137 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "70664866", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountQueryGrouping.json index caa6d869a95f..0f57c2b120e7 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/EnrollmentAccountQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "70664866", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountAlerts.json index d69d7a968e57..a92c2c68433c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountsDimensions.json index 705d4fcd3fb4..751c0b8ad9a1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountsDimensions.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountsDimensions.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountsQuery.json index b21025b0a41f..2f04900047a4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountsQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalBillingAccountsQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionAlerts.json index 92436a022d8f..a93b6acbc9a0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionForecast.json index f651e5cec87a..d2b308fbc3ff 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionsDimensions.json index 7f2217ebf526..d77744a29e35 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionsDimensions.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionsDimensions.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionsQuery.json index b71101e08ff2..ebfbb284c5dd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionsQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ExternalSubscriptionsQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/GenerateReservationDetailsReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/GenerateReservationDetailsReportByBillingAccount.json index d8c8f0f40faf..1427f1a2199c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/GenerateReservationDetailsReportByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/GenerateReservationDetailsReportByBillingAccount.json @@ -3,12 +3,12 @@ "billingAccountId": "9845612", "startDate": "2020-01-01", "endDate": "2020-01-30", - "api-version": "2019-11-01" + "api-version": "2022-10-05-preview" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2022-10-05-preview", "Retry-After": "60" } }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/GenerateReservationDetailsReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/GenerateReservationDetailsReportByBillingProfile.json index a4bd203ef284..82739862d69e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/GenerateReservationDetailsReportByBillingProfile.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/GenerateReservationDetailsReportByBillingProfile.json @@ -4,12 +4,12 @@ "billingProfileId": "CZSFR-SDFXC-DSDF", "startDate": "2020-01-01", "endDate": "2020-01-30", - "api-version": "2019-11-01" + "api-version": "2022-10-05-preview" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2022-10-05-preview", "Retry-After": "60" } }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/InvoiceSectionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/InvoiceSectionAlerts.json index d90fc5a57b18..5d37c5ec8804 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/InvoiceSectionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/InvoiceSectionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/InvoiceSectionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/InvoiceSectionForecast.json index 2b2bf5ee04c8..60b7347e9b17 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/InvoiceSectionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/InvoiceSectionForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -59,7 +59,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsList.json index 7a30ed852d58..630742bae18d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, @@ -9,30 +9,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json index 12a93024cf15..2723ac2cd1db 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "$expand": "properties/data", "$top": 5, @@ -11,8 +11,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -24,16 +24,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -45,8 +45,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsListWithFilter.json index f8c6a0ddb4b5..44ae1165bf15 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "$expand": "properties/data", "$top": 5, @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,12 +25,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-05-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountQuery.json index dfd81bcbd7cd..948935e99fd0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { @@ -55,7 +55,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountQueryGrouping.json index 31f0ffbf4ad9..29a1f1278b7c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingAccountQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", "parameters": { @@ -30,7 +30,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsList.json index 61a209e80977..c67c41b31b67 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" @@ -10,30 +10,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json index fca61ffb8f2d..a2d896554ab8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "$expand": "properties/data", @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,16 +25,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -46,8 +46,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsListWithFilter.json index 946a0fe6665d..c96d960f3520 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "$expand": "properties/data", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,12 +26,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-05-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileQuery.json index 90eff4558051..814975bb863c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileQueryGrouping.json index e110931544a8..901022322644 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCABillingProfileQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsList.json index d085114ab90d..01a481172a92 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "customerId": "5678", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" @@ -10,30 +10,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsListExpandAndTop.json index 638b70eb595b..99eb2e82880c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "customerId": "5678", "$expand": "properties/data", @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,16 +25,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -46,8 +46,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsListWithFilter.json index 3ecc017c6f8e..4139a51e997f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "customerId": "13579", "$expand": "properties/data", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,12 +26,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-05-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerQuery.json index a14f5498e0bf..7ec96e064b99 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "customerId": "5678", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", @@ -56,7 +56,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerQueryGrouping.json index a2da465d67e3..c98c3f7a491a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCACustomerQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "customerId": "5678", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", @@ -31,7 +31,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsList.json index 529439b0acbf..87defa818c16 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -11,30 +11,30 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json index 4a1cca2dea2a..b5c780f6336b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceGroup_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,16 +26,16 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, "groupingEnabled": true } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceType_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -47,8 +47,8 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, "groupingEnabled": true diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json index 3d737cf438d1..e22fc644534e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -14,8 +14,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2022-10-05-preview_2019-10-31", + "name": "dimensions_ResourceId_2022-10-05-preview_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -27,12 +27,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", - "usageEnd": "2019-10-31T00:00:00-07:00", + "usageStart": "2022-10-05T00:00:00-07:00", + "usageEnd": "2022-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-05-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionQuery.json index 909f643e09a0..1a87c0b18811 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -57,7 +57,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionQueryGrouping.json index 8c4f73f459bf..0e86fb622e1b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/MCAInvoiceSectionQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -32,7 +32,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsList.json index 381dd37759c6..4abe0a375150 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsListExpandAndTop.json index f0d980973533..81867413c0b4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "managementGroupId": "MyMgId", "$expand": "properties/data", "$top": 5, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsListWithFilter.json index 121645f857ba..25ed3603c0b1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "managementGroupId": "MyMgId", "$expand": "properties/data", "$top": 5, @@ -30,7 +30,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2022-10-05-preview&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupQuery.json index a36839a00351..53fcdd3cf7dc 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId", "parameters": { @@ -55,7 +55,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupQueryGrouping.json index 6765ec668659..7eadb70a8353 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ManagementGroupQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "managementGroupId": "MyMgId", "scope": "providers/Microsoft.Management/managementGroups/MyMgId", "parameters": { @@ -30,7 +30,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "microsoft.costmanagement/Query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2022-10-05-preview&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/OperationList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/OperationList.json index bb657778f56f..570a61254069 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/OperationList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/OperationList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01" + "api-version": "2022-10-05-preview" }, "responses": { "200": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateView.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateView.json index 4c5a6ee3e54b..d077990af89a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateView.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateView.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "viewName": "swaggerExample" }, "responses": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewCreateOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewCreateOrUpdate.json index 13fce4b9f5aa..193ac091025c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewCreateOrUpdate.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewCreateOrUpdate.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "viewName": "swaggerExample", "parameters": { "eTag": "\"1d4ff9fe66f1d10\"", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewDelete.json index 3e6638272399..c4a315a8b3db 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewDelete.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewDelete.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "viewName": "TestView" }, "responses": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewList.json index 6fc6bfdf7a68..4d8f1655992e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/PrivateViewList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01" + "api-version": "2022-10-05-preview" }, "responses": { "200": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupAlerts.json index d6b7e3e6eb4a..f356b7f292f8 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupDimensionsList.json index b8f59b39981d..d52d9cdcdca1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "system.orlando", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupForecast.json index 20fd7ba2f22e..4b5f49cbae36 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupQuery.json index fe2e639a90b7..a7daca0b5f90 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupQueryGrouping.json index ec3b75e7a4fd..9633982dafcb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ResourceGroupQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SingleResourceGroupAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SingleResourceGroupAlert.json index 0e43a5319f88..11cc5fb73d84 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SingleResourceGroupAlert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SingleResourceGroupAlert.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SingleSubscriptionAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SingleSubscriptionAlert.json index 4c2a74b2f55c..e81bbdc30a09 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SingleSubscriptionAlert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SingleSubscriptionAlert.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "alertId": "22222222-2222-2222-2222-222222222222" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionAlerts.json index 76075cc1225c..dd3fc69aaf5b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionDimensionsList.json index 7ea7c1d89059..aeadf3b065bf 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "$top": 5, "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionForecast.json index 47679e6bcdf7..2492b4f264c1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionForecast.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionQuery.json index 23534733adf4..002477eda2d2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionQuery.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionQuery.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionQueryGrouping.json index 41803cc11041..36259677ddba 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionQueryGrouping.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/SubscriptionQueryGrouping.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewByResourceGroup.json index e6ad7bccb6db..f6562be0fbe0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "viewName": "swaggerExample", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewCreateOrUpdateByResourceGroup.json index 797191b41bee..90d3d3da4f28 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewCreateOrUpdateByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewCreateOrUpdateByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", "viewName": "swaggerExample", "parameters": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewDeleteByResourceGroup.json index 2ebf54df8ad3..7b91c5e91be0 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewDeleteByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewDeleteByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", "viewName": "TestView" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewListByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewListByResourceGroup.json index 6cbb6c7431b9..79fa4b162676 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewListByResourceGroup.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2022-10-05-preview/examples/ViewListByResourceGroup.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01", + "api-version": "2022-10-05-preview", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" }, "responses": { diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.json index 121a92a639c7..5439eb1611b5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/preview/2023-04-01-preview/costmanagement.json @@ -1115,7 +1115,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", - "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", + "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1178,7 +1178,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", - "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", + "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json index c0715358c833..a47ab7b5b082 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/costmanagement.json @@ -1115,7 +1115,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", - "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", + "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1178,7 +1178,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", - "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", + "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountAlerts.json index 92e85a187afc..f9024ad66462 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountDimensionsListExpandAndTop.json index 34c0efbeedf4..f435e98f196b 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "100", "$expand": "properties/data", "$top": 5, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountDimensionsListWithFilter.json index 79382668a3d6..bfed7d54c878 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "100", "$expand": "properties/data", "$top": 5, @@ -30,7 +30,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2021-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingProfileAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingProfileAlerts.json index 62dc930b9a7f..5e33d3373e7e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingProfileAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingProfileAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingProfileForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingProfileForecast.json index e2d7f70d0b0d..8e1498b0fbfd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingProfileForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/BillingProfileForecast.json @@ -68,7 +68,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "Microsoft.CostManagement/query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentAlerts.json index a274d64fcd98..386e66f0515f 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "departmentId": "123", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentDimensionsListExpandAndTop.json index e9d8435a14ba..9878a967fa8a 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "100", "departmentId": "123", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentDimensionsListWithFilter.json index c30e2c6a89a9..ea498f746234 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DepartmentDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "100", "departmentId": "123", "$expand": "properties/data", @@ -31,7 +31,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2021-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DismissResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DismissResourceGroupAlerts.json index 5cd608f81392..f45191ddacba 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DismissResourceGroupAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DismissResourceGroupAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DismissSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DismissSubscriptionAlerts.json index 863ac58f95b8..c5a6cc478b6d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DismissSubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/DismissSubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "alertId": "22222222-2222-2222-2222-222222222222", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountAlerts.json index 3a6b90445694..cf8660216c74 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "enrollmentAccountId": "456", "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json index 0611011ef86b..a64a557a26f2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "100", "enrollmentAccountId": "456", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountDimensionsListWithFilter.json index 8d2f3a997657..69e437f56583 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/EnrollmentAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "100", "enrollmentAccountId": "456", "$expand": "properties/data", @@ -31,7 +31,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2021-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ExternalBillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ExternalBillingAccountAlerts.json index d69d7a968e57..df0754c59dd1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ExternalBillingAccountAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ExternalBillingAccountAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "externalCloudProviderId": "100", "externalCloudProviderType": "externalBillingAccounts" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ExternalSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ExternalSubscriptionAlerts.json index 92436a022d8f..d60cc3d00d7d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ExternalSubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ExternalSubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "externalCloudProviderId": "100", "externalCloudProviderType": "externalSubscriptions" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/GenerateReservationDetailsReportByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/GenerateReservationDetailsReportByBillingAccount.json index d8c8f0f40faf..f37de359f544 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/GenerateReservationDetailsReportByBillingAccount.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/GenerateReservationDetailsReportByBillingAccount.json @@ -3,12 +3,12 @@ "billingAccountId": "9845612", "startDate": "2020-01-01", "endDate": "2020-01-30", - "api-version": "2019-11-01" + "api-version": "2021-10-01" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/9845612/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2021-10-01", "Retry-After": "60" } }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/GenerateReservationDetailsReportByBillingProfile.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/GenerateReservationDetailsReportByBillingProfile.json index a4bd203ef284..e593d46be1fb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/GenerateReservationDetailsReportByBillingProfile.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/GenerateReservationDetailsReportByBillingProfile.json @@ -4,12 +4,12 @@ "billingProfileId": "CZSFR-SDFXC-DSDF", "startDate": "2020-01-01", "endDate": "2020-01-30", - "api-version": "2019-11-01" + "api-version": "2021-10-01" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2019-11-01", + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000/billingProfiles/CZSFR-SDFXC-DSDF/providers/Microsoft.CostManagement/reservationDetailsOperationResults/cf9f95c9-af6b-41dd-a622-e6f4fc60c3ee?api-version=2021-10-01", "Retry-After": "60" } }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/InvoiceSectionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/InvoiceSectionAlerts.json index d90fc5a57b18..8ab962f69966 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/InvoiceSectionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/InvoiceSectionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/InvoiceSectionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/InvoiceSectionForecast.json index bbb6d54fc64c..d1d466daa3dd 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/InvoiceSectionForecast.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/InvoiceSectionForecast.json @@ -69,7 +69,7 @@ "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", "type": "Microsoft.CostManagement/query", "properties": { - "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2021-10-01&$skiptoken=AQAAAA%3D%3D", "columns": [ { "name": "PreTaxCost", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsList.json index 7a30ed852d58..a3e5a3aa22da 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsList.json @@ -9,14 +9,14 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2021-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, @@ -24,14 +24,14 @@ } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2021-10-01_2019-10-31", + "name": "dimensions_ResourceType_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsListExpandAndTop.json index 12a93024cf15..80cf5dfc84ae 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "$expand": "properties/data", "$top": 5, @@ -11,8 +11,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2021-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -24,7 +24,7 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, @@ -32,8 +32,8 @@ } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2021-10-01_2019-10-31", + "name": "dimensions_ResourceType_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -45,7 +45,7 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsListWithFilter.json index f8c6a0ddb4b5..47d4852b1ba2 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingAccountDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "$expand": "properties/data", "$top": 5, @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2021-10-01_2019-10-31", + "name": "dimensions_ResourceId_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,12 +25,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2021-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsList.json index 61a209e80977..d6bf4e33324d 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsList.json @@ -10,14 +10,14 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2021-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, @@ -25,14 +25,14 @@ } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2021-10-01_2019-10-31", + "name": "dimensions_ResourceType_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsListExpandAndTop.json index fca61ffb8f2d..8b3eff81d590 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", "$expand": "properties/data", @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2021-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,7 +25,7 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, @@ -33,8 +33,8 @@ } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2021-10-01_2019-10-31", + "name": "dimensions_ResourceType_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -46,7 +46,7 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsListWithFilter.json index 946a0fe6665d..db018b4c1dc5 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCABillingProfileDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", "$expand": "properties/data", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2021-10-01_2019-10-31", + "name": "dimensions_ResourceId_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,12 +26,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2021-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsList.json index d085114ab90d..1b624c83b258 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsList.json @@ -10,14 +10,14 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2021-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, @@ -25,14 +25,14 @@ } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2021-10-01_2019-10-31", + "name": "dimensions_ResourceType_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsListExpandAndTop.json index 638b70eb595b..2b3fcfc8ab55 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "customerId": "5678", "$expand": "properties/data", @@ -12,8 +12,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2021-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -25,7 +25,7 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, @@ -33,8 +33,8 @@ } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2021-10-01_2019-10-31", + "name": "dimensions_ResourceType_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -46,7 +46,7 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsListWithFilter.json index 3ecc017c6f8e..e2afd0012e34 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCACustomerDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "customerId": "13579", "$expand": "properties/data", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2021-10-01_2019-10-31", + "name": "dimensions_ResourceId_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,12 +26,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2021-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsList.json index 529439b0acbf..d05e3c4b3eca 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsList.json @@ -11,14 +11,14 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2021-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, @@ -26,14 +26,14 @@ } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2021-10-01_2019-10-31", + "name": "dimensions_ResourceType_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json index 4a1cca2dea2a..138fe4213557 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -13,8 +13,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", - "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2021-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -26,7 +26,7 @@ ], "total": 377, "category": "ResourceGroup", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource group", "filterEnabled": true, @@ -34,8 +34,8 @@ } }, { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", - "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2021-10-01_2019-10-31", + "name": "dimensions_ResourceType_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -47,7 +47,7 @@ ], "total": 37, "category": "ResourceType", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource type", "filterEnabled": true, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json index 3d737cf438d1..f4a27be67ace 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "billingAccountId": "12345:6789", "billingProfileId": "13579", "invoiceSectionId": "9876", @@ -14,8 +14,8 @@ "body": { "value": [ { - "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", - "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2021-10-01_2019-10-31", + "name": "dimensions_ResourceId_2021-10-01_2019-10-31", "type": "microsoft.CostManagement/dimensions", "properties": { "data": [ @@ -27,12 +27,12 @@ ], "total": 1409, "category": "ResourceId", - "usageStart": "2019-10-01T00:00:00-07:00", + "usageStart": "2021-10-01T00:00:00-07:00", "usageEnd": "2019-10-31T00:00:00-07:00", "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2021-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ManagementGroupDimensionsListExpandAndTop.json index f0d980973533..2e851b42f012 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ManagementGroupDimensionsListExpandAndTop.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ManagementGroupDimensionsListExpandAndTop.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "managementGroupId": "MyMgId", "$expand": "properties/data", "$top": 5, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ManagementGroupDimensionsListWithFilter.json index 121645f857ba..0177451a6cfb 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ManagementGroupDimensionsListWithFilter.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ManagementGroupDimensionsListWithFilter.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "managementGroupId": "MyMgId", "$expand": "properties/data", "$top": 5, @@ -30,7 +30,7 @@ "description": "Resource Id", "filterEnabled": true, "groupingEnabled": true, - "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2021-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" } } ] diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ResourceGroupAlerts.json index d6b7e3e6eb4a..be4f52b4efb4 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ResourceGroupAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ResourceGroupAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ResourceGroupDimensionsList.json index b8f59b39981d..8d3687df4d6e 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ResourceGroupDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/ResourceGroupDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "system.orlando", "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SingleResourceGroupAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SingleResourceGroupAlert.json index 0e43a5319f88..1bf85ab72e3c 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SingleResourceGroupAlert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SingleResourceGroupAlert.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "subscriptionId": "00000000-0000-0000-0000-000000000000", "resourceGroupName": "ScreenSharingTest-peer", "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SingleSubscriptionAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SingleSubscriptionAlert.json index 4c2a74b2f55c..64c5637bbf33 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SingleSubscriptionAlert.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SingleSubscriptionAlert.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000", "alertId": "22222222-2222-2222-2222-222222222222" diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SubscriptionAlerts.json index 76075cc1225c..b63b115732a9 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SubscriptionAlerts.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SubscriptionAlerts.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2021-10-01-preview", + "api-version": "2021-10-01", "subscriptionId": "00000000-0000-0000-0000-000000000000", "scope": "subscriptions/00000000-0000-0000-0000-000000000000" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SubscriptionDimensionsList.json index 7ea7c1d89059..eafdd1d82434 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SubscriptionDimensionsList.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2021-10-01/examples/SubscriptionDimensionsList.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-10-01", + "api-version": "2021-10-01", "subscriptionId": "00000000-0000-0000-0000-000000000000", "$top": 5, "$expand": "properties/data", diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.generatecostdetailsreport.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.generatecostdetailsreport.json index eeb71ac369af..729a6b945a20 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.generatecostdetailsreport.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.generatecostdetailsreport.json @@ -39,7 +39,7 @@ "CostDetails" ], "operationId": "GenerateCostDetailsReport_CreateOperation", - "description": "This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body. To Understand cost details (formerly known as usage details) fields found in files ,see https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/understand-usage-details-fields", + "description": "This API is the replacement for all previously release Usage Details APIs. Request to generate a cost details report for the provided date range, billing period (Only enterprise customers) or Invoice Id asynchronously at a certain scope. The initial call to request a report will return a 202 with a 'Location' and 'Retry-After' header. The 'Location' header will provide the endpoint to poll to get the result of the report generation. The 'Retry-After' provides the duration to wait before polling for the generated report. A call to poll the report operation will provide a 202 response with a 'Location' header if the operation is still in progress. Once the report generation operation completes, the polling endpoint will provide a 200 response along with details on the report blob(s) that are available for download. The details on the file(s) available for download will be available in the polling response body. To Understand cost details (formerly known as usage details) fields found in files ,see https://learn.microsoft.com/azure/cost-management-billing/automate/understand-usage-details-fields", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.json index 7acf7d32cf20..7852620c34f1 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2022-10-01/costmanagement.json @@ -1115,7 +1115,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingAccountId", - "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", + "description": "Generates the reservations details report for provided date range asynchronously based on enrollment id. The Reservation usage details can be viewed only by certain enterprise roles. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/manage/understand-ea-roles#usage-and-costs-access-by-role", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, @@ -1178,7 +1178,7 @@ "ReservedInstances" ], "operationId": "GenerateReservationDetailsReport_ByBillingProfileId", - "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/en-us/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", + "description": "Generates the reservations details report for provided date range asynchronously by billing profile. The Reservation usage details can be viewed by only certain enterprise roles by default. For more details on the roles see, https://docs.microsoft.com/azure/cost-management-billing/reservations/reservation-utilization#view-utilization-in-the-azure-portal-with-azure-rbac-access", "externalDocs": { "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" }, From 3a4c77d9500f504fb2a90a9a4a993cf8fcd835b5 Mon Sep 17 00:00:00 2001 From: chcmsft <86343602+chcmsft@users.noreply.github.com> Date: Wed, 10 May 2023 13:45:20 +0800 Subject: [PATCH 57/79] 1. fix links in data v2 2. add preview statements to data registry api (#23594) --- .../maps/data-plane/Creator/preview/2.0/data.json | 12 ++++++------ .../preview/2022-12-01-preview/dataregistry.json | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/specification/maps/data-plane/Creator/preview/2.0/data.json b/specification/maps/data-plane/Creator/preview/2.0/data.json index 645517b44648..0aa1a14876ea 100644 --- a/specification/maps/data-plane/Creator/preview/2.0/data.json +++ b/specification/maps/data-plane/Creator/preview/2.0/data.json @@ -101,7 +101,7 @@ }, "UniqueDataId": { "name": "udid", - "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) call.", + "description": "The unique data id for the content. The `udid` must have been obtained from a successful [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload) call.", "type": "string", "in": "path", "required": true, @@ -126,7 +126,7 @@ "paths": { "/mapData": { "post": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The \n`dataFormat` query parameter will contain the format for the data, the `dataSharingLevel` query parameter \ncan contain the sharing level for the data. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \nlong-running operation.\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete-preview) to \ndelete old/unused content and create space for new uploads.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Upload API allows the caller to upload data content to the Azure Maps service.\nYou can use this API in a scenario like uploading a collection of Geofences in `GeoJSON` \nformat, for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n## Submit Upload Request\n\nTo upload your content you will use a `POST` request. The request body will contain the data to upload. The \n`dataFormat` query parameter will contain the format for the data, the `dataSharingLevel` query parameter \ncan contain the sharing level for the data. The `Content-Type` header will be set to the content type of the \ndata.\n\nFor example, to upload a collection of geofences in `GeoJSON` format, set the request body to the geofence \ncontent. Set the `dataFormat` query parameter to _geojson_, and set the `Content-Type` header to either one \nof the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for uploading a simple Geofence represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe Data Upload API performs a \nlong-running operation.\n\n## Data Upload Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete) to \ndelete old/unused content and create space for new uploads.", "operationId": "Data_Upload", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -180,7 +180,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a list of all content uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview). \n\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n### Submit List Request\n\nTo list all your map data content you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe Data List API returns the complete list of all data in `json` format. The response contains the following details for each data resource:\n\n > udid - The unique data id for the data resource.\n\n > location - The location of the data resource. Execute a HTTP `GET` on this location to download the data.\n\n\nHere's a sample response returning the `udid` and `location` of 3 data resources: \n\n
\n\n```json\n{\n \"mapDataList\": \n [\n {\n \"udid\": \"9a1288fa-1858-4a3b-b68d-13a8j5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\"\n }]\n}\n```\n\n
", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to fetch a list of all content uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload). \n\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n### Submit List Request\n\nTo list all your map data content you will issue a `GET` request with no additional parameters.\n\n\n### List Data Response\n\nThe Data List API returns the complete list of all data in `json` format. The response contains the following details for each data resource:\n\n > udid - The unique data id for the data resource.\n\n > location - The location of the data resource. Execute a HTTP `GET` on this location to download the data.\n\n\nHere's a sample response returning the `udid` and `location` of 3 data resources: \n\n
\n\n```json\n{\n \"mapDataList\": \n [\n {\n \"udid\": \"9a1288fa-1858-4a3b-b68d-13a8j5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/9a1288fa-1858-4a3b-b68d-13a8j5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 29920,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"8b1288fa-1958-4a2b-b68e-13a7i5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/8b1288fa-1958-4a2b-b68e-13a7i5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1339,\n \"uploadStatus\": \"Completed\"\n },\n {\n \"udid\": \"7c1288fa-2058-4a1b-b68f-13a6h5af7d7c\",\n \"location\": \"https://us.atlas.microsoft.com/mapData/7c1288fa-2058-4a1b-b68f-13a6h5af7d7c?api-version=1.0\",\n \"sizeInBytes\": 1650,\n \"uploadStatus\": \"Pending\"\n }]\n}\n```\n\n
", "operationId": "Data_List", "x-ms-examples": { "List all the previously uploaded data": { @@ -210,7 +210,7 @@ }, "/mapData/{udid}": { "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Update API allows the caller to update a previously uploaded data content.\n\nYou can use this API in a scenario like adding or removing geofences to or from an existing collection of geofences. \nGeofences are uploaded using the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload-preview), for \nuse in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n## Submit Update Request\n\nTo update your content you will use a `PUT` request. The request body will contain the new data that will replace \nthe existing data. The `Content-Type` header will be set to the content type of the data, and the path will contain \nthe `udid` of the data to be update.\n\nFor example, to update a collection of geofences that were previously uploaded using the Upload API, place the new \ngeofence content in the request body. Set the `udid` parameter in the path to the `udid` of the data received \npreviously in the upload API response. And set the `Content-Type` header to one of the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for updating a simple Geofence. It's represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe previously uploaded geofence had a radius of 100m. The above request will update it to 500m.\n\nThe Data Update API performs a \nlong-running operation.\n\n## Data Update Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete-preview) to \ndelete old/unused content and create space for new uploads.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe Data Update API allows the caller to update a previously uploaded data content.\n\nYou can use this API in a scenario like adding or removing geofences to or from an existing collection of geofences. \nGeofences are uploaded using the [Data Upload API](https://docs.microsoft.com/rest/api/maps/data-v2/upload), for \nuse in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial).\n\nPlease note that the Update API will *replace* and *override* the existing data content.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n## Submit Update Request\n\nTo update your content you will use a `PUT` request. The request body will contain the new data that will replace \nthe existing data. The `Content-Type` header will be set to the content type of the data, and the path will contain \nthe `udid` of the data to be update.\n\nFor example, to update a collection of geofences that were previously uploaded using the Upload API, place the new \ngeofence content in the request body. Set the `udid` parameter in the path to the `udid` of the data received \npreviously in the upload API response. And set the `Content-Type` header to one of the following media types:\n\n- `application/json`\n- `application/vnd.geo+json`\n- `application/octet-stream`\n\nHere's a sample request body for updating a simple Geofence. It's represented as a circle geometry using a center \npoint and a radius. The sample below is in `GeoJSON`:\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```\n\nThe previously uploaded geofence had a radius of 100m. The above request will update it to 500m.\n\nThe Data Update API performs a \nlong-running operation.\n\n## Data Update Limits\n\nPlease, be aware that currently every Azure Maps account has a [data storage limit](https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-subscription-service-limits#azure-maps-limits). \nOnce the storage limit is reached, all the new upload API calls will return a `409 Conflict` http error response. \nYou can always use the [Data Delete API](https://docs.microsoft.com/rest/api/maps/data-v2/delete) to \ndelete old/unused content and create space for new uploads.", "operationId": "Data_Update", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -260,7 +260,7 @@ } }, "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to download a previously uploaded data content.
\nYou can use this API in a scenario like downloading an existing collection of geofences uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). \n\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n### Submit Download Request\n\nTo download your content you will use a `GET` request where the path will contain the `udid` of the data to download. Optionally, you can also pass in an `Accept` header to specify a preference for the `Content-Type` of the data response.
\nFor example, to download a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response and set the `Accept` header to either one of the following media types: \n \n - `application/json`\n - `application/vnd.geo+json`\n - `application/octet-stream`\n\n\n### Download Data Response\n\nThe Download API will return a HTTP `200 OK` response if the data resource with the passed-in `udid` is found, where the response body will contain the content of the data resource.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.
\n\nHere's a sample response body for a simple geofence represented in `GeoJSON` uploaded previously using the Upload API:\n
\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to download a previously uploaded data content.
\nYou can use this API in a scenario like downloading an existing collection of geofences uploaded previously using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). \n\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n### Submit Download Request\n\nTo download your content you will use a `GET` request where the path will contain the `udid` of the data to download. Optionally, you can also pass in an `Accept` header to specify a preference for the `Content-Type` of the data response.
\nFor example, to download a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response and set the `Accept` header to either one of the following media types: \n \n - `application/json`\n - `application/vnd.geo+json`\n - `application/octet-stream`\n\n\n### Download Data Response\n\nThe Download API will return a HTTP `200 OK` response if the data resource with the passed-in `udid` is found, where the response body will contain the content of the data resource.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found.
\n\nHere's a sample response body for a simple geofence represented in `GeoJSON` uploaded previously using the Upload API:\n
\n\n```json\n{\n \"type\": \"FeatureCollection\",\n \"features\": [{\n \"type\": \"Feature\",\n \"geometry\": {\n \"type\": \"Point\",\n \"coordinates\": [-122.126986, 47.639754]\n },\n \"properties\": {\n \"geometryId\": \"001\",\n \"radius\": 500\n }\n }]\n}\n```", "operationId": "Data_Download", "x-ms-examples": { "Download previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { @@ -302,7 +302,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a previously uploaded data content.
\nYou can use this API in a scenario like removing geofences previously uploaded using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload-preview) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `udid` of the data to delete.
\nFor example, to delete a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. \n\n\n### Delete Data Response\n\nThe Data Delete API returns a HTTP `204 No Content` response with an empty body, if the data resource was deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found. ", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThis API allows the caller to delete a previously uploaded data content.
\nYou can use this API in a scenario like removing geofences previously uploaded using the [Data Upload API](https://docs.microsoft.com/en-us/rest/api/maps/data-v2/upload) for use in our [Azure Maps Geofencing Service](https://docs.microsoft.com/en-us/rest/api/maps/spatial). You can also use this API to delete old/unused uploaded content and create space for new content.\n\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n### Submit Delete Request\n\nTo delete your content you will issue a `DELETE` request where the path will contain the `udid` of the data to delete.
\nFor example, to delete a collection of geofences previously uploaded using the Upload API, set the `udid` parameter in the path to the `udid` of the data received previously in the upload API response. \n\n\n### Delete Data Response\n\nThe Data Delete API returns a HTTP `204 No Content` response with an empty body, if the data resource was deleted successfully.
\nA HTTP `400 Bad Request` error response will be returned if the data resource with the passed-in `udid` is not found. ", "operationId": "Data_Delete", "x-ms-examples": { "Delete previously uploaded GeoJSON data containing geometries that represent a collection of geofences": { diff --git a/specification/maps/data-plane/DataRegistry/preview/2022-12-01-preview/dataregistry.json b/specification/maps/data-plane/DataRegistry/preview/2022-12-01-preview/dataregistry.json index a32ac83aede6..0677c89a7448 100644 --- a/specification/maps/data-plane/DataRegistry/preview/2022-12-01-preview/dataregistry.json +++ b/specification/maps/data-plane/DataRegistry/preview/2022-12-01-preview/dataregistry.json @@ -99,7 +99,7 @@ "paths": { "/dataRegistries": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `List` request returns an array containing all data registries previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace).\n\nThis API won't check whether Azure Maps can access the underlying content and whether integrity check is passed for each data registry. Please use [Get Content](https://docs.microsoft.com/rest/api/maps/data-registry/get-content) for the latest status individually.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit List Request\n\nTo list all your data registries, issue a `GET` request with no additional parameters.\n\n## List Response\n\nThe `List` request returns an array of data registries in `JSON` format in the body of the response.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `List` request returns an array containing all data registries previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace).\n\nThis API won't check whether Azure Maps can access the underlying content and whether integrity check is passed for each data registry. Please use [Get Content](https://docs.microsoft.com/rest/api/maps/data-registry/get-content) for the latest status individually.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n## Submit List Request\n\nTo list all your data registries, issue a `GET` request with no additional parameters.\n\n## List Response\n\nThe `List` request returns an array of data registries in `JSON` format in the body of the response.", "operationId": "DataRegistry_List", "x-ms-examples": { "List all previously registered data registries": { @@ -139,7 +139,7 @@ }, "/dataRegistries/{udid}": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Get Data Registry` request returns the data registry information, as an [AzureBlob](#azureblob) object in JSON format, in the body of the response along with the HTTP status code of 200 when successful. If Azure Maps cannot access the underlying content or the integrity check fails, the `status` is set to `Failed` and and error is returned.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Get Data Registry Request\n\nA data registry `GET` request returns details of the requested data registry, as determined by the specified `udid`. The details are returned in the body of the response in JSON format.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Get Data Registry` request returns the data registry information, as an [AzureBlob](#azureblob) object in JSON format, in the body of the response along with the HTTP status code of 200 when successful. If Azure Maps cannot access the underlying content or the integrity check fails, the `status` is set to `Failed` and and error is returned.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n## Submit Get Data Registry Request\n\nA data registry `GET` request returns details of the requested data registry, as determined by the specified `udid`. The details are returned in the body of the response in JSON format.", "operationId": "DataRegistry_GetDataRegistry", "x-ms-examples": { "Get the data registry of a completed udid": { @@ -183,7 +183,7 @@ } }, "put": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Register` request is used to register data in an Azure Storage Account with an Azure Maps account. The maximum file size that can be registered is one gigabyte.\n\nThis is useful in scenarios like registering a collection of Geofences in `GeoJSON` format for use in [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or registering a set of DWG design files as a zipped [Drawing Package](https://docs.microsoft.com/azure/azure-maps/drawing-requirements) for use in the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Register or Replace Request\n\nThe `Register` and `Replace` requests are both long-running operations that contain an [AzureBlob](#azureblob) JSON object in the body of the request that defines the data registry details.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Register` request is used to register data in an Azure Storage Account with an Azure Maps account. The maximum file size that can be registered is one gigabyte.\n\nThis is useful in scenarios like registering a collection of Geofences in `GeoJSON` format for use in [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or registering a set of DWG design files as a zipped [Drawing Package](https://docs.microsoft.com/azure/azure-maps/drawing-requirements) for use in the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n## Submit Register or Replace Request\n\nThe `Register` and `Replace` requests are both long-running operations that contain an [AzureBlob](#azureblob) JSON object in the body of the request that defines the data registry details.", "operationId": "DataRegistry_RegisterOrReplace", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { @@ -266,7 +266,7 @@ } }, "delete": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Unregister` request removes a data registry without deleting the underlying content frm the Azure storage account.\n\nUseful in scenarios like unregistering geofence files previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace) for use in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or unregistering a compressed (ZIP) file containing DWG design files used by the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Unregister Request\n\nUse an HTTP `DELETE` request with the `udid` of the data registry to unregister.\n\n## Unregister Response\n\nThe `Unregister` request returns a HTTP '204 No Content' response with an empty body, if the data registry was deleted successfully.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Unregister` request removes a data registry without deleting the underlying content frm the Azure storage account.\n\nUseful in scenarios like unregistering geofence files previously registered using the [Register or Replace API](https://docs.microsoft.com/rest/api/maps/data-registry/register-or-replace) for use in the [Azure Maps Geofencing Service](https://docs.microsoft.com/rest/api/maps/spatial), or unregistering a compressed (ZIP) file containing DWG design files used by the Azure Maps Creator [Conversion Service](https://docs.microsoft.com/rest/api/maps/v2/conversion).\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n## Submit Unregister Request\n\nUse an HTTP `DELETE` request with the `udid` of the data registry to unregister.\n\n## Unregister Response\n\nThe `Unregister` request returns a HTTP '204 No Content' response with an empty body, if the data registry was deleted successfully.", "operationId": "DataRegistry_Unregister", "x-ms-examples": { "Unregister a data registry without deleting the underlying contents": { @@ -306,7 +306,7 @@ }, "/dataRegistries/{udid}/content": { "get": { - "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Get Content` request returns the contents of the specified file in the body of the response. The content is not available if the status is `Running` or `Failed`.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n## Submit Get Content Request\n\nTo get the contents of a registered file, include the user data ID (`udid`) in a `dataRegistries` request.\n\n## Get Content Response\n\nThe `Get Content` request returns the contents of the file in the response body, along with the HTTP status code of 200 when successful. The HTTP status code 400 (Bad Request) is returned if the file registry process failed or is still running.", + "description": "**Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier).\n\nThe `Get Content` request returns the contents of the specified file in the body of the response. The content is not available if the status is `Running` or `Failed`.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n## Submit Get Content Request\n\nTo get the contents of a registered file, include the user data ID (`udid`) in a `dataRegistries` request.\n\n## Get Content Response\n\nThe `Get Content` request returns the contents of the file in the response body, along with the HTTP status code of 200 when successful. The HTTP status code 400 (Bad Request) is returned if the file registry process failed or is still running.", "operationId": "DataRegistry_GetContent", "x-ms-examples": { "Download previously registered GeoJSON content": { @@ -359,7 +359,7 @@ }, "/dataRegistries/operations/{operationId}": { "get": { - "description": "The HTTP `GET` request used to get the status of a [data register or replace](/rest/api/maps/data-registry/register-or-replace) request is returned in the header of the register or replace response as the value of the `Operation-Location` key. While in progress, a HTTP `200 OK` response will be returned with `Retry-After` header - followed by a HTTP `200 OK` with no extra header once completed.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.", + "description": "The HTTP `GET` request used to get the status of a [data register or replace](/rest/api/maps/data-registry/register-or-replace) request is returned in the header of the register or replace response as the value of the `Operation-Location` key. While in progress, a HTTP `200 OK` response will be returned with `Retry-After` header - followed by a HTTP `200 OK` with no extra header once completed.\n\nThe data registry service endpoint is limited in scope to the region of your Azure Maps account and is not available for global Azure Maps accounts.\n\n>[!Important]\n>By using this feature, you agree to the preview legal terms. See the [Preview Supplemental Terms](https://azure.microsoft.com/en-us/support/legal/preview-supplemental-terms/) for additional details.\n", "operationId": "DataRegistry_GetOperation", "x-ms-examples": { "Get the status of an operation that is still running": { From 756495dd7e0e2f5181039def47a8c85ff0787b66 Mon Sep 17 00:00:00 2001 From: sushantyadav-msft <87296742+sushantyadav-msft@users.noreply.github.com> Date: Wed, 10 May 2023 12:29:42 +0530 Subject: [PATCH 58/79] reverted the description that the service is in preview (#23868) --- .../stable/2023-04-01/SAPVirtualInstance.json | 2 +- .../Microsoft.Workloads/stable/2023-04-01/monitors.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/SAPVirtualInstance.json b/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/SAPVirtualInstance.json index 59462b7b40f8..86d59eddc7f9 100644 --- a/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/SAPVirtualInstance.json +++ b/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/SAPVirtualInstance.json @@ -3,7 +3,7 @@ "info": { "version": "2023-04-01", "title": "Workloads Client", - "description": "Workloads client provides access to various workload operations.
Azure Center for SAP solutions is currently in PREVIEW. See the [Azure Center for SAP solutions - Legal Terms](https://learn.microsoft.com/legal/azure-center-for-sap-solutions/azure-center-for-sap-solutions-legal-terms) for legal notices applicable to Azure Center for SAP solutions." + "description": "Workloads client provides access to various workload operations." }, "host": "management.azure.com", "schemes": [ diff --git a/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/monitors.json b/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/monitors.json index c20610a32598..ee3d9e068fb4 100644 --- a/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/monitors.json +++ b/specification/workloads/resource-manager/Microsoft.Workloads/stable/2023-04-01/monitors.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "title": "Workloads Client", - "description": "The workload SAP monitor Client.
Azure Monitor for SAP solutions is currently in PREVIEW. See the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/) for legal terms that apply to Azure features that are in beta, preview, or otherwise not yet released into general availability.", + "description": "The workload SAP monitor Client.", "version": "2023-04-01" }, "host": "management.azure.com", From fb9c8e2ca33e9723c2b2fc849f627329067feb54 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Wed, 10 May 2023 18:44:22 -0700 Subject: [PATCH 59/79] Rename property in sample ContosoWidgetManager (#23836) * Rename property to "createdAt" - Aligns with naming guidelines * tsp compile * Add test change to trigger TypeSpec ApiView * Test removal of "postinstall: tsc" * Revert "Test removal of "postinstall: tsc"" This reverts commit 3e9b154f21e37d5a09311d08cfdc3387f74028ab. * Revert "Add test change to trigger TypeSpec ApiView" This reverts commit 837bf37ff8e3cd7e53be7dc4fa14f9e24fe8130f. * Update examples --- .../Contoso.WidgetManager.Shared/main.tsp | 2 +- .../Widgets_CreateOrUpdateWidgetSample.json | 6 +++--- .../Widgets_GetWidgetOperationStatusSample.json | 2 +- .../2022-11-01-preview/Widgets_ListWidgetsSample.json | 2 +- .../examples/Widgets_CreateOrUpdateWidgetSample.json | 6 +++--- .../examples/Widgets_GetWidgetOperationStatusSample.json | 2 +- .../examples/Widgets_ListWidgetsSample.json | 2 +- .../preview/2022-11-01-preview/widgets.json | 6 +++--- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager.Shared/main.tsp b/specification/contosowidgetmanager/Contoso.WidgetManager.Shared/main.tsp index 68dc135bd136..1b94bb705031 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager.Shared/main.tsp +++ b/specification/contosowidgetmanager/Contoso.WidgetManager.Shared/main.tsp @@ -4,5 +4,5 @@ model FakedSharedModel { tag: string; @doc("The created date.") - createdDate: utcDateTime; + createdAt: utcDateTime; } diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_CreateOrUpdateWidgetSample.json b/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_CreateOrUpdateWidgetSample.json index 7bc10a6367ae..f3f2a8b0056c 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_CreateOrUpdateWidgetSample.json +++ b/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_CreateOrUpdateWidgetSample.json @@ -8,7 +8,7 @@ "manufacturerId": "manufacturer id1", "sharedModel": { "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" + "createdAt": "2023-01-09T02:12:25.689Z" } } }, @@ -19,7 +19,7 @@ "manufacturerId": "manufacturer id1", "sharedModel": { "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" + "createdAt": "2023-01-09T02:12:25.689Z" } } }, @@ -29,7 +29,7 @@ "manufacturerId": "manufacturer id1", "sharedModel": { "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" + "createdAt": "2023-01-09T02:12:25.689Z" } } } diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_GetWidgetOperationStatusSample.json b/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_GetWidgetOperationStatusSample.json index c88b6155b003..3d3b76b030dc 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_GetWidgetOperationStatusSample.json +++ b/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_GetWidgetOperationStatusSample.json @@ -35,7 +35,7 @@ "manufacturerId": "manufacturer Id1", "sharedModel": { "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" + "createdAt": "2023-01-09T02:12:25.689Z" } }, "widgetName": "rfazvwnfwwomiwrh" diff --git a/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_ListWidgetsSample.json b/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_ListWidgetsSample.json index 60cfc8902fb8..5b7d6e82d933 100644 --- a/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_ListWidgetsSample.json +++ b/specification/contosowidgetmanager/Contoso.WidgetManager/examples/2022-11-01-preview/Widgets_ListWidgetsSample.json @@ -16,7 +16,7 @@ "manufacturerId": "manufacturer Id1", "sharedModel": { "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" + "createdAt": "2023-01-09T02:12:25.689Z" } } ], diff --git a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_CreateOrUpdateWidgetSample.json b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_CreateOrUpdateWidgetSample.json index 7bc10a6367ae..f3f2a8b0056c 100644 --- a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_CreateOrUpdateWidgetSample.json +++ b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_CreateOrUpdateWidgetSample.json @@ -8,7 +8,7 @@ "manufacturerId": "manufacturer id1", "sharedModel": { "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" + "createdAt": "2023-01-09T02:12:25.689Z" } } }, @@ -19,7 +19,7 @@ "manufacturerId": "manufacturer id1", "sharedModel": { "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" + "createdAt": "2023-01-09T02:12:25.689Z" } } }, @@ -29,7 +29,7 @@ "manufacturerId": "manufacturer id1", "sharedModel": { "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" + "createdAt": "2023-01-09T02:12:25.689Z" } } } diff --git a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_GetWidgetOperationStatusSample.json b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_GetWidgetOperationStatusSample.json index c88b6155b003..3d3b76b030dc 100644 --- a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_GetWidgetOperationStatusSample.json +++ b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_GetWidgetOperationStatusSample.json @@ -35,7 +35,7 @@ "manufacturerId": "manufacturer Id1", "sharedModel": { "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" + "createdAt": "2023-01-09T02:12:25.689Z" } }, "widgetName": "rfazvwnfwwomiwrh" diff --git a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_ListWidgetsSample.json b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_ListWidgetsSample.json index 60cfc8902fb8..5b7d6e82d933 100644 --- a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_ListWidgetsSample.json +++ b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/examples/Widgets_ListWidgetsSample.json @@ -16,7 +16,7 @@ "manufacturerId": "manufacturer Id1", "sharedModel": { "tag": "tag1", - "createdDate": "2023-01-09T02:12:25.689Z" + "createdAt": "2023-01-09T02:12:25.689Z" } } ], diff --git a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json index 545a9fd14613..86334ef4fb6d 100644 --- a/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json +++ b/specification/contosowidgetmanager/data-plane/Azure.Contoso.WidgetManager/preview/2022-11-01-preview/widgets.json @@ -427,7 +427,7 @@ "type": "string", "description": "The tag." }, - "createdDate": { + "createdAt": { "type": "string", "format": "date-time", "description": "The created date." @@ -436,7 +436,7 @@ "description": "Faked shared model", "required": [ "tag", - "createdDate" + "createdAt" ] }, "FakedSharedModelUpdate": { @@ -446,7 +446,7 @@ "type": "string", "description": "The tag." }, - "createdDate": { + "createdAt": { "type": "string", "format": "date-time", "description": "The created date." From 1f449b5a17448f05ce1cd914f8ed75a0b568d130 Mon Sep 17 00:00:00 2001 From: Nan Zang Date: Wed, 10 May 2023 19:56:25 -0700 Subject: [PATCH 60/79] Review request for Microsoft.SecurityInsights to add version preview/2023-05-01-preview (#23610) * Adds base for updating Microsoft.SecurityInsights from version preview/2023-04-01-preview to version 2023-05-01-preview * Updates readme * Updates API version in new specs and examples * BillingStatistics 2023-05-01-preview (#23631) * BillingStatistics * Update BillingStatistics path in readme * add gcp kind (#23691) * add gcp kind * fix prettier --------- Co-authored-by: destinywu <114768181+destinywu@users.noreply.github.com> Co-authored-by: danielohfeld <98688758+danielohfeld@users.noreply.github.com> --- .../2023-05-01-preview/AlertRules.json | 2543 ++++++++++++++ .../2023-05-01-preview/AutomationRules.json | 1495 ++++++++ .../2023-05-01-preview/BillingStatistics.json | 226 ++ .../preview/2023-05-01-preview/Bookmarks.json | 751 ++++ .../2023-05-01-preview/ContentPackages.json | 453 +++ .../ContentProductPackages.json | 297 ++ .../ContentProductTemplates.json | 298 ++ .../2023-05-01-preview/ContentTemplates.json | 400 +++ .../2023-05-01-preview/Enrichment.json | 381 ++ .../preview/2023-05-01-preview/Entities.json | 1556 ++++++++ .../2023-05-01-preview/EntityQueries.json | 507 +++ .../EntityQueryTemplates.json | 304 ++ .../2023-05-01-preview/FileImports.json | 564 +++ .../preview/2023-05-01-preview/Hunts.json | 992 ++++++ .../preview/2023-05-01-preview/Incidents.json | 1658 +++++++++ .../preview/2023-05-01-preview/Metadata.json | 824 +++++ .../2023-05-01-preview/OfficeConsents.json | 234 ++ .../2023-05-01-preview/OnboardingStates.json | 284 ++ .../2023-05-01-preview/Recommendations.json | 564 +++ .../SecurityMLAnalyticsSettings.json | 444 +++ .../preview/2023-05-01-preview/Settings.json | 423 +++ .../2023-05-01-preview/SourceControls.json | 735 ++++ .../ThreatIntelligence.json | 1097 ++++++ .../TriggeredAnalyticsRuleRuns.json | 353 ++ .../2023-05-01-preview/Watchlists.json | 721 ++++ .../WorkspaceManagerAssignments.json | 737 ++++ .../WorkspaceManagerConfigurations.json | 323 ++ .../WorkspaceManagerGroups.json | 318 ++ .../WorkspaceManagerMembers.json | 310 ++ .../2023-05-01-preview/common/AlertTypes.json | 81 + .../common/ContentCommonTypes.json | 429 +++ .../common/EntityTypes.json | 2550 ++++++++++++++ .../common/IncidentTypes.json | 246 ++ .../common/RelationTypes.json | 95 + .../common/ThreatIntelligenceTypes.json | 48 + .../2023-05-01-preview/dataConnectors.json | 3118 +++++++++++++++++ .../actions/CreateActionOfAlertRule.json | 43 + .../actions/DeleteActionOfAlertRule.json | 14 + .../actions/GetActionOfAlertRuleById.json | 24 + .../actions/GetAllActionsByAlertRule.json | 27 + .../GetAlertRuleTemplateById.json | 53 + .../GetAlertRuleTemplates.json | 238 ++ .../alertRules/CreateFusionAlertRule.json | 845 +++++ ...nAlertRuleWithFusionScenarioExclusion.json | 851 +++++ ...softSecurityIncidentCreationAlertRule.json | 58 + .../alertRules/CreateNrtAlertRule.json | 136 + .../alertRules/CreateScheduledAlertRule.json | 270 ++ .../examples/alertRules/DeleteAlertRule.json | 13 + .../examples/alertRules/GetAllAlertRules.json | 412 +++ .../alertRules/GetFusionAlertRule.json | 310 ++ ...softSecurityIncidentCreationAlertRule.json | 30 + .../examples/alertRules/GetNrtAlertRule.json | 55 + .../alertRules/GetScheduledAlertRule.json | 95 + .../AutomationRules_CreateOrUpdate.json | 171 + .../AutomationRules_Delete.json | 17 + .../automationRules/AutomationRules_Get.json | 65 + .../automationRules/AutomationRules_List.json | 68 + .../GetAllBillingStatistics.json | 26 + .../GetBillingStatistic.json | 23 + .../examples/bookmarks/CreateBookmark.json | 143 + .../examples/bookmarks/DeleteBookmark.json | 13 + .../examples/bookmarks/GetBookmarkById.json | 64 + .../examples/bookmarks/GetBookmarks.json | 67 + .../bookmarks/expand/PostExpandBookmark.json | 43 + .../relations/CreateBookmarkRelation.json | 43 + .../relations/DeleteBookmarkRelation.json | 14 + .../relations/GetAllBookmarkRelations.json | 28 + .../relations/GetBookmarkRelationByName.json | 25 + .../contentPackages/GetPackageById.json | 33 + .../examples/contentPackages/GetPackages.json | 38 + .../GetProductPackageById.json | 75 + .../contentPackages/GetProductPackages.json | 77 + .../contentPackages/InstallPackage.json | 148 + .../contentPackages/UninstallPackage.json | 13 + .../contentTemplates/DeleteTemplate.json | 13 + .../GetProductTemplateById.json | 41 + .../contentTemplates/GetProductTemplates.json | 43 + .../contentTemplates/GetTemplateById.json | 39 + .../contentTemplates/GetTemplates.json | 41 + .../contentTemplates/InstallTemplate.json | 222 ++ ...CheckRequirementsAzureActiveDirectory.json | 22 + ...tsAzureActiveDirectoryNoAuthorization.json | 22 + ...irementsAzureActiveDirectoryNoLicense.json | 22 + .../CheckRequirementsAzureSecurityCenter.json | 22 + .../CheckRequirementsDynamics365.json | 22 + .../dataConnectors/CheckRequirementsIoT.json | 22 + .../CheckRequirementsMdatp.json | 22 + ...RequirementsMicrosoftCloudAppSecurity.json | 22 + ...MicrosoftPurviewInformationProtection.json | 22 + ...quirementsMicrosoftThreatIntelligence.json | 22 + ...RequirementsMicrosoftThreatProtection.json | 22 + .../CheckRequirementsOffice365Project.json | 22 + .../CheckRequirementsOfficeATP.json | 22 + .../CheckRequirementsOfficeIRM.json | 22 + .../CheckRequirementsOfficePowerBI.json | 22 + .../CheckRequirementsThreatIntelligence.json | 22 + ...ckRequirementsThreatIntelligenceTaxii.json | 22 + .../dataConnectors/ConnectAPIPolling.json | 24 + .../ConnectAPIPollingV2Logs.json | 27 + .../dataConnectors/CreateAPIPolling.json | 368 ++ .../CreateDynamics365DataConnetor.json | 57 + .../dataConnectors/CreateGenericUI.json | 437 +++ .../CreateGoogleCloudPlatform.json | 92 + ...viewInformationProtectionDataConnetor.json | 57 + ...rosoftThreatIntelligenceDataConnector.json | 59 + ...MicrosoftThreatProtectionDataConnetor.json | 81 + .../CreateOffice365ProjectDataConnetor.json | 57 + .../CreateOfficeDataConnetor.json | 75 + .../CreateOfficePowerBIDataConnector.json | 57 + ...CreateThreatIntelligenceDataConnector.json | 59 + ...eThreatIntelligenceTaxiiDataConnector.json | 81 + .../dataConnectors/DeleteAPIPolling.json | 13 + .../dataConnectors/DeleteGenericUI.json | 13 + .../DeleteGoogleCloudPlatform.json | 13 + ...viewInformationProtectionDataConnetor.json | 13 + ...rosoftThreatIntelligenceDataConnector.json | 13 + .../DeleteOffice365ProjectDataConnetor.json | 13 + .../DeleteOfficeDataConnetor.json | 13 + .../DeleteOfficePowerBIDataConnetor.json | 13 + .../dataConnectors/DisconnectAPIPolling.json | 13 + .../dataConnectors/GetAPIPolling.json | 133 + .../GetAmazonWebServicesCloudTrailById.json | 28 + .../GetAmazonWebServicesS3ById.json | 32 + .../GetAzureActiveDirectoryById.json | 28 + .../GetAzureAdvancedThreatProtectionById.json | 28 + .../GetAzureSecurityCenterById.json | 28 + .../dataConnectors/GetDataConnectors.json | 508 +++ .../GetDynamics365DataConnectorById.json | 28 + .../examples/dataConnectors/GetGenericUI.json | 156 + .../GetGoogleCloudPlatformById.json | 35 + .../examples/dataConnectors/GetIoTById.json | 28 + .../GetMicrosoftCloudAppSecurityById.json | 31 + ...tDefenderAdvancedThreatProtectionById.json | 28 + ...GetMicrosoftInsiderRiskManagementById.json | 28 + ...InformationProtectionDataConnetorById.json | 28 + .../GetMicrosoftThreatIntelligenceById.json | 29 + .../GetMicrosoftThreatProtectionById.json | 36 + ...Office365AdvancedThreatProtectionById.json | 28 + .../GetOffice365ProjectDataConnetorById.json | 28 + .../GetOfficeDataConnetorById.json | 34 + .../GetOfficePowerBIDataConnetorById.json | 28 + .../GetThreatIntelligenceById.json | 29 + .../GetThreatIntelligenceTaxiiById.json | 36 + .../examples/enrichment/GetGeodataByIp.json | 31 + .../enrichment/GetWhoisByDomainName.json | 87 + .../entities/GetAccountEntityById.json | 32 + .../entities/GetAzureResourceEntityById.json | 24 + .../GetCloudApplicationEntityById.json | 25 + .../examples/entities/GetDnsEntityById.json | 26 + .../examples/entities/GetEntities.json | 63 + .../examples/entities/GetFileEntityById.json | 24 + .../entities/GetFileHashEntityById.json | 24 + .../examples/entities/GetHostEntityById.json | 31 + .../entities/GetIoTDeviceEntityById.json | 45 + .../examples/entities/GetIpEntityById.json | 23 + .../entities/GetMailClusterEntityById.json | 44 + .../entities/GetMailMessageEntityById.json | 48 + .../entities/GetMailboxEntityById.json | 26 + .../entities/GetMalwareEntityById.json | 24 + .../entities/GetProcessEntityById.json | 25 + .../examples/entities/GetQueries.json | 456 +++ .../entities/GetRegistryKeyEntityById.json | 24 + .../entities/GetRegistryValueEntityById.json | 26 + .../entities/GetSecurityAlertEntityById.json | 51 + .../entities/GetSecurityGroupEntityById.json | 25 + .../entities/GetSubmissionMailEntityById.json | 29 + .../examples/entities/GetUrlEntityById.json | 23 + .../entities/expand/PostExpandEntity.json | 52 + .../entities/insights/PostGetInsights.json | 100 + .../relations/GetAllEntityRelations.json | 28 + .../relations/GetEntityRelationByName.json | 25 + .../entities/timeline/PostTimelineEntity.json | 92 + .../CreateEntityQueryActivity.json | 133 + .../entityQueries/DeleteEntityQuery.json | 13 + .../GetActivityEntityQueryById.json | 54 + .../entityQueries/GetEntityQueries.json | 59 + .../GetExpansionEntityQueryById.json | 34 + .../GetActivityEntityQueryTemplateById.json | 57 + .../GetEntityQueryTemplates.json | 105 + .../fileImports/CreateFileImport.json | 49 + .../fileImports/DeleteFileImport.json | 41 + .../fileImports/GetFileImportById.json | 37 + .../examples/fileImports/GetFileImports.json | 42 + .../examples/hunts/CreateHunt.json | 100 + .../examples/hunts/CreateHuntComment.json | 56 + .../examples/hunts/CreateHuntRelation.json | 53 + .../examples/hunts/DeleteHunt.json | 14 + .../examples/hunts/DeleteHuntComment.json | 15 + .../examples/hunts/DeleteHuntRelation.json | 15 + .../examples/hunts/GetHuntById.json | 43 + .../examples/hunts/GetHuntCommentById.json | 32 + .../examples/hunts/GetHuntComments.json | 27 + .../examples/hunts/GetHuntRelationById.json | 29 + .../examples/hunts/GetHuntRelations.json | 32 + .../examples/hunts/GetHunts.json | 46 + .../IncidentAlerts/Incidents_ListAlerts.json | 50 + .../Incidents_ListBookmarks.json | 47 + .../IncidentComments_CreateOrUpdate.json | 55 + .../IncidentComments_Delete.json | 14 + .../IncidentComments_Get.json | 31 + .../IncidentComments_List.json | 34 + .../Incidents_ListEntities.json | 34 + .../IncidentTasks_CreateOrUpdate.json | 73 + .../IncidentTasks/IncidentTasks_Delete.json | 14 + .../IncidentTasks/IncidentTasks_Get.json | 39 + .../IncidentTasks/IncidentTasks_List.json | 42 + .../IncidentTeam/Incidents_CreateTeam.json | 26 + .../incidents/Incidents_CreateOrUpdate.json | 136 + .../examples/incidents/Incidents_Delete.json | 13 + .../examples/incidents/Incidents_Get.json | 63 + .../examples/incidents/Incidents_List.json | 68 + .../relations/CreateIncidentRelation.json | 43 + .../relations/DeleteIncidentRelation.json | 14 + .../relations/GetAllIncidentRelations.json | 40 + .../relations/GetIncidentRelationByName.json | 25 + .../manualTrigger/Entities_RunPlaybook.json | 17 + .../manualTrigger/Incidents_RunPlaybook.json | 18 + .../examples/metadata/DeleteMetadata.json | 13 + .../examples/metadata/GetAllMetadata.json | 64 + .../metadata/GetAllMetadataOData.json | 52 + .../examples/metadata/GetMetadata.json | 104 + .../examples/metadata/PatchMetadata.json | 35 + .../examples/metadata/PutMetadata.json | 286 ++ .../examples/metadata/PutMetadataMinimal.json | 40 + .../officeConsents/DeleteOfficeConsents.json | 13 + .../officeConsents/GetOfficeConsents.json | 25 + .../officeConsents/GetOfficeConsentsById.json | 22 + .../CreateSentinelOnboardingState.json | 36 + .../DeleteSentinelOnboardingState.json | 13 + .../GetAllSentinelOnboardingStates.json | 24 + .../GetSentinelOnboardingState.json | 21 + .../examples/operations/ListOperations.json | 563 +++ .../recommendations/GetRecommendation.json | 48 + .../recommendations/GetRecommendations.json | 51 + .../recommendations/PatchRecommendation.json | 56 + .../repositories/GetRepositories.json | 25 + ...eateAnomalySecurityMLAnalyticsSetting.json | 245 ++ .../DeleteSecurityMLAnalyticsSetting.json | 13 + .../GetAllSecurityMLAnalyticsSettings.json | 94 + .../GetAnomalySecurityMLAnalyticsSetting.json | 91 + .../settings/DeleteEyesOnSetting.json | 13 + .../examples/settings/GetAllSettings.json | 25 + .../examples/settings/GetEyesOnSetting.json | 22 + .../settings/UpdateEyesOnSetting.json | 28 + .../sourcecontrols/CreateSourceControl.json | 168 + .../sourcecontrols/DeleteSourceControl.json | 13 + .../sourcecontrols/GetSourceControlById.json | 76 + .../sourcecontrols/GetSourceControls.json | 79 + .../AppendTagsThreatIntelligence.json | 18 + .../CollectThreatIntelligenceMetrics.json | 43 + .../CreateThreatIntelligence.json | 100 + .../DeleteThreatIntelligence.json | 13 + .../GetThreatIntelligence.json | 76 + .../GetThreatIntelligenceById.json | 43 + .../QueryThreatIntelligence.json | 107 + .../ReplaceTagsThreatIntelligence.json | 52 + .../UpdateThreatIntelligence.json | 101 + .../triggerRuleRun_Post.json | 23 + .../triggeredAnalyticsRuleRun_Get.json | 29 + .../triggeredAnalyticsRuleRuns_Get.json | 48 + .../examples/watchlists/CreateWatchlist.json | 88 + .../CreateWatchlistAndWatchlistItems.json | 92 + .../watchlists/CreateWatchlistItem.json | 92 + .../examples/watchlists/DeleteWatchlist.json | 18 + .../watchlists/DeleteWatchlistItem.json | 15 + .../watchlists/GetWatchlistByAlias.json | 50 + .../watchlists/GetWatchlistItemById.json | 47 + .../watchlists/GetWatchlistItems.json | 50 + .../examples/watchlists/GetWatchlists.json | 53 + .../CreateJob.json | 24 + ...ateOrUpdateWorkspaceManagerAssignment.json | 62 + .../DeleteJob.json | 14 + .../DeleteWorkspaceManagerAssignment.json | 13 + .../GetAllJobs.json | 46 + .../GetAllWorkspaceManagerAssignments.json | 35 + .../workspaceManagerAssignments/GetJob.json | 43 + .../GetWorkspaceManagerAssignment.json | 32 + ...OrUpdateWorkspaceManagerConfiguration.json | 38 + .../DeleteWorkspaceManagerConfiguration.json | 13 + .../GetAllWorkspaceManagerConfigurations.json | 25 + .../GetWorkspaceManagerConfiguration.json | 22 + .../CreateOrUpdateWorkspaceManagerGroup.json | 53 + .../DeleteWorkspaceManagerGroup.json | 13 + .../GetAllWorkspaceManagerGroups.json | 30 + .../GetWorkspaceManagerGroup.json | 27 + .../CreateOrUpdateWorkspaceManagerMember.json | 41 + .../DeleteWorkspaceManagerMember.json | 13 + .../GetAllWorkspaceManagerMembers.json | 26 + .../GetWorkspaceManagerMember.json | 23 + .../2023-05-01-preview/operations.json | 138 + .../resource-manager/readme.md | 44 +- 291 files changed, 42646 insertions(+), 3 deletions(-) create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/AlertRules.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/AutomationRules.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/BillingStatistics.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Bookmarks.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentProductPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentProductTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Enrichment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Entities.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/EntityQueries.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/EntityQueryTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/FileImports.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Hunts.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Incidents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Metadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/OfficeConsents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/OnboardingStates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Recommendations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/SecurityMLAnalyticsSettings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Settings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/SourceControls.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/TriggeredAnalyticsRuleRuns.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Watchlists.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerAssignments.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerConfigurations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerGroups.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerMembers.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/AlertTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/ContentCommonTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/EntityTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/IncidentTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/RelationTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/ThreatIntelligenceTypes.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/dataConnectors.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/CreateActionOfAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/DeleteActionOfAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/GetActionOfAlertRuleById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/GetAllActionsByAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateFusionAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateNrtAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateScheduledAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/DeleteAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetAllAlertRules.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetFusionAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetNrtAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetScheduledAlertRule.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/billingStatistics/GetAllBillingStatistics.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/billingStatistics/GetBillingStatistic.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/CreateBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/DeleteBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/GetBookmarkById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/GetBookmarks.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/expand/PostExpandBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetPackageById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetProductPackageById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetProductPackages.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/InstallPackage.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/UninstallPackage.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/DeleteTemplate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetProductTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetProductTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/InstallTemplate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsIoT.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/ConnectAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateGenericUI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteGenericUI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DisconnectAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAPIPolling.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetDataConnectors.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetGenericUI.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetIoTById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/enrichment/GetGeodataByIp.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/enrichment/GetWhoisByDomainName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetAccountEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetAzureResourceEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetCloudApplicationEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetDnsEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetEntities.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetFileEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetFileHashEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetHostEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetIoTDeviceEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetIpEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailClusterEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailMessageEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailboxEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMalwareEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetProcessEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetQueries.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetRegistryKeyEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetRegistryValueEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSecurityAlertEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSecurityGroupEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSubmissionMailEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetUrlEntityById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/expand/PostExpandEntity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/insights/PostGetInsights.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/relations/GetAllEntityRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/relations/GetEntityRelationByName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/timeline/PostTimelineEntity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/CreateEntityQueryActivity.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/DeleteEntityQuery.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetActivityEntityQueryById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetEntityQueries.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/CreateFileImport.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/DeleteFileImport.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/GetFileImportById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/GetFileImports.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHunt.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHuntComment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHuntRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHunt.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHuntComment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHuntRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntCommentById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntComments.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntRelationById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHunts.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_CreateOrUpdate.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_Delete.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_List.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/CreateIncidentRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/DeleteIncidentRelation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/GetAllIncidentRelations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/GetIncidentRelationByName.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/manualTrigger/Entities_RunPlaybook.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/DeleteMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetAllMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetAllMetadataOData.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PatchMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PutMetadata.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PutMetadataMinimal.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/DeleteOfficeConsents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/GetOfficeConsents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/GetOfficeConsentsById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/operations/ListOperations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/GetRecommendation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/GetRecommendations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/PatchRecommendation.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/repositories/GetRepositories.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/DeleteEyesOnSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/GetAllSettings.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/GetEyesOnSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/UpdateEyesOnSetting.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/CreateSourceControl.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/DeleteSourceControl.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/GetSourceControlById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/GetSourceControls.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/CreateThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/GetThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/QueryThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlist.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlistItem.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/DeleteWatchlist.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/DeleteWatchlistItem.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistByAlias.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistItemById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistItems.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlists.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/CreateJob.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/DeleteJob.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetJob.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/operations.json diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/AlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/AlertRules.json new file mode 100644 index 000000000000..fe3cadd7a16a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/AlertRules.json @@ -0,0 +1,2543 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules": { + "get": { + "x-ms-examples": { + "Get all alert rules.": { + "$ref": "./examples/alertRules/GetAllAlertRules.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Gets all alert rules.", + "operationId": "AlertRules_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}": { + "get": { + "x-ms-examples": { + "Get a Scheduled alert rule.": { + "$ref": "./examples/alertRules/GetScheduledAlertRule.json" + }, + "Get an Nrt alert rule.": { + "$ref": "./examples/alertRules/GetNrtAlertRule.json" + }, + "Get a Fusion alert rule.": { + "$ref": "./examples/alertRules/GetFusionAlertRule.json" + }, + "Get a MicrosoftSecurityIncidentCreation rule.": { + "$ref": "./examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Gets the alert rule.", + "operationId": "AlertRules_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a Scheduled alert rule.": { + "$ref": "./examples/alertRules/CreateScheduledAlertRule.json" + }, + "Creates or updates a Nrt alert rule.": { + "$ref": "./examples/alertRules/CreateNrtAlertRule.json" + }, + "Creates or updates a Fusion alert rule.": { + "$ref": "./examples/alertRules/CreateFusionAlertRule.json" + }, + "Creates or updates a Fusion alert rule with scenario exclusion pattern.": { + "$ref": "./examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json" + }, + "Creates or updates a MicrosoftSecurityIncidentCreation rule.": { + "$ref": "./examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Creates or updates the alert rule.", + "operationId": "AlertRules_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/AlertRule" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AlertRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an alert rule.": { + "$ref": "./examples/alertRules/DeleteAlertRule.json" + } + }, + "tags": [ + "Alert Rules" + ], + "description": "Delete the alert rule.", + "operationId": "AlertRules_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions": { + "get": { + "x-ms-examples": { + "Get all actions of alert rule.": { + "$ref": "./examples/actions/GetAllActionsByAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Gets all actions of alert rule.", + "operationId": "Actions_ListByAlertRule", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/actions/{actionId}": { + "get": { + "x-ms-examples": { + "Get an action of alert rule.": { + "$ref": "./examples/actions/GetActionOfAlertRuleById.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Gets the action of alert rule.", + "operationId": "Actions_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an action of alert rule.": { + "$ref": "./examples/actions/CreateActionOfAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Creates or updates the action of alert rule.", + "operationId": "Actions_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + }, + { + "$ref": "#/parameters/Action" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ActionResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an action of alert rule.": { + "$ref": "./examples/actions/DeleteActionOfAlertRule.json" + } + }, + "tags": [ + "Actions" + ], + "description": "Delete the action of alert rule.", + "operationId": "Actions_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/ActionId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates": { + "get": { + "x-ms-examples": { + "Get all alert rule templates.": { + "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplates.json" + } + }, + "tags": [ + "Alert Rule Templates" + ], + "description": "Gets all alert rule templates.", + "operationId": "AlertRuleTemplates_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRuleTemplatesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates/{alertRuleTemplateId}": { + "get": { + "x-ms-examples": { + "Get alert rule template by Id.": { + "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplateById.json" + } + }, + "tags": [ + "Alert Rule Templates" + ], + "description": "Gets the alert rule template.", + "operationId": "AlertRuleTemplates_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AlertRuleTemplateId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AlertRuleTemplate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "Action": { + "description": "The action", + "in": "body", + "name": "action", + "required": true, + "schema": { + "$ref": "#/definitions/ActionRequest" + }, + "x-ms-parameter-location": "method" + }, + "ActionId": { + "description": "Action ID", + "in": "path", + "name": "actionId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AlertRule": { + "description": "The alert rule", + "in": "body", + "name": "alertRule", + "required": true, + "schema": { + "$ref": "#/definitions/AlertRule" + }, + "x-ms-parameter-location": "method" + }, + "AlertRuleTemplateId": { + "description": "Alert rule template ID", + "in": "path", + "name": "alertRuleTemplateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "RuleId": { + "description": "Alert rule ID", + "in": "path", + "name": "ruleId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "AlertRule": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Alert rule.", + "properties": { + "kind": { + "$ref": "#/definitions/AlertRuleKindEnum", + "description": "The kind of the alert rule" + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "AlertRuleKindEnum": { + "description": "The kind of the alert rule", + "enum": [ + "Scheduled", + "MicrosoftSecurityIncidentCreation", + "Fusion", + "MLBehaviorAnalytics", + "ThreatIntelligence", + "NRT" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertRuleKind", + "values": [ + { + "value": "Scheduled" + }, + { + "value": "MicrosoftSecurityIncidentCreation" + }, + { + "value": "Fusion" + }, + { + "value": "MLBehaviorAnalytics" + }, + { + "value": "ThreatIntelligence" + }, + { + "value": "NRT" + } + ] + } + }, + "AlertRuleTemplate": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "Alert rule template.", + "discriminator": "kind", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/AlertRuleKindEnum", + "description": "The kind of the alert rule" + } + }, + "required": [ + "kind" + ] + }, + "AlertRuleTemplateDataSource": { + "description": "alert rule template data sources", + "properties": { + "connectorId": { + "description": "The connector id that provides the following data types", + "type": "string" + }, + "dataTypes": { + "description": "The data types used by the alert rule template", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AlertRuleTemplatePropertiesBase": { + "description": "Base alert rule template property bag.", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "type": "integer", + "format": "int32" + }, + "lastUpdatedDateUTC": { + "description": "The last time that this alert rule template has been updated.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "createdDateUTC": { + "description": "The time that this alert rule template has been added.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the alert rule template.", + "type": "string" + }, + "displayName": { + "description": "The display name for alert rule template.", + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data sources for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "x-ms-identifiers": [ + "connectorId" + ], + "type": "array" + }, + "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status." + } + }, + "type": "object" + }, + "AlertRuleTemplateStatus": { + "description": "The alert rule template status.", + "enum": [ + "Installed", + "Available", + "NotAvailable" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TemplateStatus", + "values": [ + { + "description": "Alert rule template installed. and can not use more then once", + "value": "Installed" + }, + { + "description": "Alert rule template is available.", + "value": "Available" + }, + { + "description": "Alert rule template is not available", + "value": "NotAvailable" + } + ] + } + }, + "AlertRuleTemplateWithMitreProperties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + } + ], + "description": "Alert rule template with MITRE property bag.", + "properties": { + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "QueryBasedAlertRuleTemplateProperties": { + "description": "Query based alert rule template base property bag.", + "properties": { + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + }, + "version": { + "description": "The version of this template - in format , where all are numbers. For example <1.0.2>.", + "type": "string" + }, + "customDetails": { + "description": "Dictionary of string key-value pairs of columns to be attached to the alert", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappings", + "description": "Array of the entity mappings of the alert rule" + }, + "alertDetailsOverride": { + "type": "object", + "$ref": "#/definitions/AlertDetailsOverride", + "description": "The alert details override settings" + }, + "eventGroupingSettings": { + "$ref": "#/definitions/EventGroupingSettings", + "description": "The event grouping settings." + }, + "sentinelEntitiesMappings": { + "$ref": "#/definitions/SentinelEntitiesMappings", + "description": "Array of the sentinel entity mappings of the alert rule" + } + }, + "type": "object" + }, + "AlertRuleTemplatesList": { + "description": "List all the alert rule templates.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alert rule templates.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of alert rule templates.", + "items": { + "$ref": "#/definitions/AlertRuleTemplate" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "AlertRuleTriggerOperator": { + "description": "The operation against the threshold that triggers alert rule.", + "enum": [ + "GreaterThan", + "LessThan", + "Equal", + "NotEqual" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "TriggerOperator" + } + }, + "AlertRulesList": { + "description": "List all the alert rules.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alert rules.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of alert rules.", + "items": { + "$ref": "#/definitions/AlertRule" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "MLBehaviorAnalyticsAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents MLBehaviorAnalytics alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/MLBehaviorAnalyticsAlertRuleProperties", + "description": "MLBehaviorAnalytics alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MLBehaviorAnalytics" + }, + "MLBehaviorAnalyticsAlertRuleProperties": { + "description": "MLBehaviorAnalytics alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "readOnly": true, + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert rule has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "MLBehaviorAnalyticsAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents MLBehaviorAnalytics alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplateWithMitreProperties" + } + ], + "description": "MLBehaviorAnalytics alert rule template properties.", + "properties": { + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + } + }, + "type": "object", + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MLBehaviorAnalytics" + }, + "FusionAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents Fusion alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/FusionAlertRuleProperties", + "description": "Fusion alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Fusion" + }, + "FusionAlertRuleProperties": { + "description": "Fusion alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "readOnly": true, + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "sourceSettings": { + "description": "Configuration for all supported source signals in fusion detection.", + "items": { + "$ref": "#/definitions/FusionSourceSettings" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "scenarioExclusionPatterns": { + "description": "Configuration to exclude scenarios in fusion detection.", + "items": { + "$ref": "#/definitions/FusionScenarioExclusionPattern" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "FusionSourceSettings": { + "description": "Represents a supported source signal configuration in Fusion detection.", + "properties": { + "enabled": { + "description": "Determines whether this source signal is enabled or disabled in Fusion detection.", + "type": "boolean" + }, + "sourceName": { + "description": "Name of the Fusion source signal. Refer to Fusion alert rule template for supported values.", + "type": "string" + }, + "sourceSubTypes": { + "description": "Configuration for all source subtypes under this source signal consumed in fusion detection.", + "items": { + "$ref": "#/definitions/FusionSourceSubTypeSetting" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "enabled", + "sourceName" + ], + "type": "object" + }, + "FusionSourceSubTypeSetting": { + "description": "Represents a supported source subtype configuration under a source signal in Fusion detection.", + "properties": { + "enabled": { + "description": "Determines whether this source subtype under source signal is enabled or disabled in Fusion detection.", + "type": "boolean" + }, + "sourceSubTypeName": { + "description": "The Name of the source subtype under a given source signal in Fusion detection. Refer to Fusion alert rule template for supported values.", + "type": "string" + }, + "sourceSubTypeDisplayName": { + "description": "The display name of source subtype under a source signal consumed in Fusion detection.", + "type": "string", + "readOnly": true + }, + "severityFilters": { + "description": "Severity configuration for a source subtype consumed in fusion detection.", + "$ref": "#/definitions/FusionSubTypeSeverityFilter", + "type": "object" + } + }, + "required": [ + "enabled", + "sourceSubTypeName", + "severityFilters" + ], + "type": "object" + }, + "FusionSubTypeSeverityFilter": { + "description": "Represents severity configuration for a source subtype consumed in Fusion detection.", + "properties": { + "isSupported": { + "description": "Determines whether this source subtype supports severity configuration or not.", + "type": "boolean", + "readOnly": true + }, + "filters": { + "description": "Individual Severity configuration settings for a given source subtype consumed in Fusion detection.", + "items": { + "$ref": "#/definitions/FusionSubTypeSeverityFiltersItem" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "type": "object" + }, + "FusionSubTypeSeverityFiltersItem": { + "description": "Represents a Severity filter setting for a given source subtype consumed in Fusion detection.", + "properties": { + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The Severity for a given source subtype consumed in Fusion detection." + }, + "enabled": { + "description": "Determines whether this severity is enabled or disabled for this source subtype consumed in Fusion detection.", + "type": "boolean" + } + }, + "required": [ + "severity", + "enabled" + ], + "type": "object" + }, + "FusionScenarioExclusionPattern": { + "description": "Represents a Fusion scenario exclusion patterns in Fusion detection.", + "properties": { + "exclusionPattern": { + "description": "Scenario exclusion pattern.", + "type": "string" + }, + "dateAddedInUTC": { + "description": "DateTime when scenario exclusion pattern is added in UTC.", + "type": "string" + } + }, + "required": [ + "exclusionPattern", + "dateAddedInUTC" + ], + "type": "object" + }, + "FusionAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents Fusion alert rule template.", + "properties": { + "properties": { + "$ref": "#/definitions/FusionAlertRuleTemplateProperties", + "description": "Fusion alert rule template properties", + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Fusion" + }, + "FusionAlertRuleTemplateProperties": { + "description": "Fusion alert rule template properties", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "format": "int32", + "type": "integer" + }, + "createdDateUTC": { + "description": "The time that this alert rule template has been added.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastUpdatedDateUTC": { + "description": "The time that this alert rule template was last updated.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the alert rule template.", + "type": "string" + }, + "displayName": { + "description": "The display name for alert rule template.", + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data connectors for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status.", + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "sourceSettings": { + "description": "All supported source signal configurations consumed in fusion detection.", + "items": { + "$ref": "#/definitions/FusionTemplateSourceSetting" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "type": "object", + "x-ms-client-flatten": true + }, + "FusionTemplateSourceSetting": { + "description": "Represents a source signal consumed in Fusion detection.", + "properties": { + "sourceName": { + "description": "The name of a source signal consumed in Fusion detection.", + "type": "string" + }, + "sourceSubTypes": { + "description": "All supported source subtypes under this source signal consumed in fusion detection.", + "items": { + "$ref": "#/definitions/FusionTemplateSourceSubType" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "sourceName" + ], + "type": "object" + }, + "FusionTemplateSourceSubType": { + "description": "Represents a source subtype under a source signal consumed in Fusion detection.", + "properties": { + "sourceSubTypeName": { + "description": "The name of source subtype under a source signal consumed in Fusion detection.", + "type": "string" + }, + "sourceSubTypeDisplayName": { + "description": "The display name of source subtype under a source signal consumed in Fusion detection.", + "type": "string", + "readOnly": true + }, + "severityFilter": { + "description": "Severity configuration available for a source subtype consumed in fusion detection.", + "$ref": "#/definitions/FusionTemplateSubTypeSeverityFilter", + "type": "object" + } + }, + "required": [ + "sourceSubTypeName", + "severityFilter" + ], + "type": "object" + }, + "FusionTemplateSubTypeSeverityFilter": { + "description": "Represents severity configurations available for a source subtype consumed in Fusion detection.", + "properties": { + "isSupported": { + "description": "Determines whether severity configuration is supported for this source subtype consumed in Fusion detection.", + "type": "boolean" + }, + "severityFilters": { + "description": "List of all supported severities for this source subtype consumed in Fusion detection.", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "isSupported" + ], + "type": "object" + }, + "ThreatIntelligenceAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents Threat Intelligence alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ThreatIntelligenceAlertRuleProperties", + "description": "Threat Intelligence alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "ThreatIntelligenceAlertRuleProperties": { + "description": "Threat Intelligence alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "readOnly": true, + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "required": [ + "alertRuleTemplateName", + "enabled" + ], + "type": "object" + }, + "ThreatIntelligenceAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents Threat Intelligence alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplateWithMitreProperties" + } + ], + "description": "Threat Intelligence alert rule template properties", + "properties": { + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + } + }, + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "type": "object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "MicrosoftSecurityIncidentCreationAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents MicrosoftSecurityIncidentCreation rule.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleProperties", + "description": "MicrosoftSecurityIncidentCreation rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" + }, + "MicrosoftSecurityIncidentCreationAlertRuleCommonProperties": { + "description": "MicrosoftSecurityIncidentCreation rule common property bag.", + "properties": { + "displayNamesFilter": { + "description": "the alerts' displayNames on which the cases will be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayNamesExcludeFilter": { + "description": "the alerts' displayNames on which the cases will not be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "productFilter": { + "$ref": "#/definitions/MicrosoftSecurityProductName", + "description": "The alerts' productName on which the cases will be generated" + }, + "severitiesFilter": { + "description": "the alerts' severities on which the cases will be generated", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum" + }, + "type": "array" + } + }, + "required": [ + "productFilter" + ], + "type": "object" + }, + "MicrosoftSecurityProductName": { + "description": "The alerts' productName on which the cases will be generated", + "enum": [ + "Microsoft Cloud App Security", + "Azure Security Center", + "Azure Advanced Threat Protection", + "Azure Active Directory Identity Protection", + "Azure Security Center for IoT", + "Office 365 Advanced Threat Protection", + "Microsoft Defender Advanced Threat Protection" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MicrosoftSecurityProductName" + } + }, + "MicrosoftSecurityIncidentCreationAlertRuleProperties": { + "allOf": [ + { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" + } + ], + "description": "MicrosoftSecurityIncidentCreation rule property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "displayName", + "enabled", + "productFilter" + ], + "type": "object" + }, + "MicrosoftSecurityIncidentCreationAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents MicrosoftSecurityIncidentCreation rule template.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties", + "description": "MicrosoftSecurityIncidentCreation rule template properties", + "required": [ + "displayName", + "description", + "createdDateUTC", + "status", + "alertRulesCreatedByTemplateCount", + "productFilter" + ], + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftSecurityIncidentCreation" + }, + "MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" + } + ], + "description": "MicrosoftSecurityIncidentCreation rule template properties", + "properties": { + "displayNamesFilter": { + "description": "the alerts' displayNames on which the cases will be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayNamesExcludeFilter": { + "description": "the alerts' displayNames on which the cases will not be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "productFilter": { + "$ref": "#/definitions/MicrosoftSecurityProductName", + "description": "The alerts' productName on which the cases will be generated" + }, + "severitiesFilter": { + "description": "the alerts' severities on which the cases will be generated", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum" + }, + "type": "array" + } + }, + "type": "object", + "x-ms-client-flatten": true + }, + "ScheduledAlertRuleProperties": { + "allOf": [ + { + "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" + } + ], + "description": "Scheduled alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "templateVersion": { + "description": "The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert rule has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "suppressionDuration": { + "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.", + "format": "duration", + "type": "string" + }, + "suppressionEnabled": { + "description": "Determines whether the suppression for this alert rule is enabled or disabled.", + "type": "boolean" + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "incidentConfiguration": { + "$ref": "#/definitions/IncidentConfiguration", + "description": "The settings of the incidents that created from alerts triggered by this analytics rule" + } + }, + "required": [ + "displayName", + "enabled", + "severity", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold", + "suppressionEnabled", + "suppressionDuration" + ], + "type": "object", + "x-ms-client-flatten": true + }, + "NrtAlertRuleProperties": { + "description": "Nrt alert rule base property bag.", + "properties": { + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "templateVersion": { + "description": "The version of the alert rule template used to create this rule - in format , where all are numbers, for example 0 <1.0.2>", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "type": "string" + }, + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array" + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert rule has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "suppressionDuration": { + "description": "The suppression (in ISO 8601 duration format) to wait since last time this alert rule been triggered.", + "format": "duration", + "type": "string" + }, + "suppressionEnabled": { + "description": "Determines whether the suppression for this alert rule is enabled or disabled.", + "type": "boolean" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + }, + "incidentConfiguration": { + "$ref": "#/definitions/IncidentConfiguration", + "description": "The settings of the incidents that created from alerts triggered by this analytics rule" + }, + "customDetails": { + "description": "Dictionary of string key-value pairs of columns to be attached to the alert", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappings", + "description": "Array of the entity mappings of the alert rule" + }, + "alertDetailsOverride": { + "type": "object", + "$ref": "#/definitions/AlertDetailsOverride", + "description": "The alert details override settings" + }, + "eventGroupingSettings": { + "$ref": "#/definitions/EventGroupingSettings", + "description": "The event grouping settings." + }, + "sentinelEntitiesMappings": { + "$ref": "#/definitions/SentinelEntitiesMappings", + "description": "Array of the sentinel entity mappings of the alert rule" + } + }, + "required": [ + "displayName", + "enabled", + "severity", + "query", + "suppressionEnabled", + "suppressionDuration" + ], + "type": "object", + "x-ms-client-flatten": true + }, + "ScheduledAlertRuleTemplateProperties": { + "description": "Scheduled alert rule template properties", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "format": "int32", + "type": "integer" + }, + "createdDateUTC": { + "description": "The time that this alert rule template has been added.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastUpdatedDateUTC": { + "description": "The time that this alert rule template was last updated.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the alert rule template.", + "type": "string" + }, + "displayName": { + "description": "The display name for alert rule template.", + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data connectors for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status.", + "type": "string" + }, + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "queryFrequency": { + "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", + "format": "duration", + "type": "string" + }, + "queryPeriod": { + "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", + "format": "duration", + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + }, + "triggerOperator": { + "$ref": "#/definitions/AlertRuleTriggerOperator", + "description": "The operation against the threshold that triggers alert rule." + }, + "triggerThreshold": { + "description": "The threshold triggers this alert rule.", + "format": "int32", + "type": "integer" + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "techniques": { + "description": "The techniques of the alert rule", + "items": { + "type": "string" + }, + "type": "array" + }, + "version": { + "description": "The version of this template - in format , where all are numbers. For example <1.0.2>.", + "type": "string" + }, + "eventGroupingSettings": { + "$ref": "#/definitions/EventGroupingSettings", + "description": "The event grouping settings." + }, + "customDetails": { + "description": "Dictionary of string key-value pairs of columns to be attached to the alert", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappings", + "description": "Array of the entity mappings of the alert rule" + }, + "alertDetailsOverride": { + "type": "object", + "$ref": "#/definitions/AlertDetailsOverride", + "description": "The alert details override settings" + }, + "sentinelEntitiesMappings": { + "$ref": "#/definitions/SentinelEntitiesMappings", + "description": "Array of the sentinel entity mappings of the alert rule" + } + }, + "type": "object" + }, + "ScheduledAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents scheduled alert rule template.", + "properties": { + "properties": { + "$ref": "#/definitions/ScheduledAlertRuleTemplateProperties", + "description": "Scheduled alert rule template properties", + "required": [ + "displayName", + "description", + "status", + "alertRulesCreatedByTemplateCount", + "severity", + "query", + "queryFrequency", + "queryPeriod", + "triggerOperator", + "triggerThreshold", + "version" + ], + "type": "object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Scheduled" + }, + "NrtAlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplate" + } + ], + "description": "Represents NRT alert rule template.", + "properties": { + "properties": { + "allOf": [ + { + "$ref": "#/definitions/AlertRuleTemplateWithMitreProperties" + }, + { + "$ref": "#/definitions/QueryBasedAlertRuleTemplateProperties" + } + ], + "description": "NRT alert rule template properties", + "required": [ + "displayName", + "description", + "status", + "alertRulesCreatedByTemplateCount", + "severity", + "query", + "version" + ], + "type": "object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "NRT" + }, + "EventGroupingSettings": { + "description": "Event grouping settings property bag.", + "properties": { + "aggregationKind": { + "$ref": "#/definitions/EventGroupingAggregationKind" + } + }, + "type": "object" + }, + "EventGroupingAggregationKind": { + "description": "The event grouping aggregation kinds", + "enum": [ + "SingleAlert", + "AlertPerResult" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EventGroupingAggregationKind" + } + }, + "ScheduledAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents scheduled alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ScheduledAlertRuleProperties", + "description": "Scheduled alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Scheduled" + }, + "NrtAlertRule": { + "allOf": [ + { + "$ref": "#/definitions/AlertRule" + } + ], + "description": "Represents NRT alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/NrtAlertRuleProperties", + "description": "NRT alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "NRT" + }, + "ScheduledAlertRuleCommonProperties": { + "description": "Scheduled alert rule template property bag.", + "properties": { + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "queryFrequency": { + "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", + "format": "duration", + "type": "string" + }, + "queryPeriod": { + "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", + "format": "duration", + "type": "string" + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity for alerts created by this alert rule." + }, + "triggerOperator": { + "$ref": "#/definitions/AlertRuleTriggerOperator", + "description": "The operation against the threshold that triggers alert rule." + }, + "triggerThreshold": { + "description": "The threshold triggers this alert rule.", + "type": "integer", + "format": "int32" + }, + "eventGroupingSettings": { + "$ref": "#/definitions/EventGroupingSettings", + "description": "The event grouping settings." + }, + "customDetails": { + "description": "Dictionary of string key-value pairs of columns to be attached to the alert", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappings", + "description": "Array of the entity mappings of the alert rule" + }, + "alertDetailsOverride": { + "type": "object", + "$ref": "#/definitions/AlertDetailsOverride", + "description": "The alert details override settings" + }, + "sentinelEntitiesMappings": { + "$ref": "#/definitions/SentinelEntitiesMappings", + "description": "Array of the sentinel entity mappings of the alert rule" + } + }, + "type": "object" + }, + "EntityMappings": { + "description": "List of entity mappings of the alert rule", + "type": "array", + "items": { + "$ref": "#/definitions/EntityMapping" + }, + "x-ms-identifiers": [] + }, + "EntityMapping": { + "description": "Single entity mapping for the alert rule", + "properties": { + "entityType": { + "$ref": "#/definitions/EntityMappingType" + }, + "fieldMappings": { + "description": "array of field mappings for the given entity mapping", + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "FieldMapping": { + "description": "A single field mapping of the mapped entity", + "properties": { + "identifier": { + "description": "the V3 identifier of the entity", + "type": "string" + }, + "columnName": { + "description": "the column name to be mapped to the identifier", + "type": "string" + } + }, + "type": "object" + }, + "SentinelEntitiesMappings": { + "description": "List of sentinel entity mappings of the alert rule", + "type": "array", + "items": { + "$ref": "#/definitions/SentinelEntityMapping" + }, + "x-ms-identifiers": [] + }, + "SentinelEntityMapping": { + "description": "A single sentinel entity mapping", + "properties": { + "columnName": { + "description": "the column name to be mapped to the SentinelEntities", + "type": "string" + } + }, + "type": "object" + }, + "AlertDetailsOverride": { + "description": "Settings for how to dynamically override alert static details", + "properties": { + "alertDisplayNameFormat": { + "description": "the format containing columns name(s) to override the alert name", + "type": "string" + }, + "alertDescriptionFormat": { + "description": "the format containing columns name(s) to override the alert description", + "type": "string" + }, + "alertTacticsColumnName": { + "description": "the column name to take the alert tactics from", + "type": "string" + }, + "alertSeverityColumnName": { + "description": "the column name to take the alert severity from", + "type": "string" + }, + "alertDynamicProperties": { + "description": "List of additional dynamic properties to override", + "type": "array", + "items": { + "$ref": "#/definitions/AlertPropertyMapping" + }, + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "AlertPropertyMapping": { + "description": "A single alert property mapping to override", + "properties": { + "alertProperty": { + "$ref": "#/definitions/AlertProperty" + }, + "value": { + "description": "the column name to use to override this property", + "type": "string" + } + }, + "type": "object" + }, + "IncidentConfiguration": { + "description": "Incident Configuration property bag.", + "properties": { + "createIncident": { + "description": "Create incidents from alerts triggered by this analytics rule", + "type": "boolean" + }, + "groupingConfiguration": { + "$ref": "#/definitions/GroupingConfiguration", + "description": "Set how the alerts that are triggered by this analytics rule, are grouped into incidents" + } + }, + "type": "object", + "required": [ + "createIncident" + ] + }, + "GroupingConfiguration": { + "description": "Grouping configuration property bag.", + "properties": { + "enabled": { + "description": "Grouping enabled", + "type": "boolean" + }, + "reopenClosedIncident": { + "description": "Re-open closed matching incidents", + "type": "boolean" + }, + "lookbackDuration": { + "description": "Limit the group to alerts created within the lookback duration (in ISO 8601 duration format)", + "format": "duration", + "type": "string" + }, + "matchingMethod": { + "description": "Grouping matching method. When method is Selected at least one of groupByEntities, groupByAlertDetails, groupByCustomDetails must be provided and not empty.", + "enum": [ + "AllEntities", + "AnyAlert", + "Selected" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MatchingMethod", + "values": [ + { + "description": "Grouping alerts into a single incident if all the entities match", + "value": "AllEntities" + }, + { + "description": "Grouping any alerts triggered by this rule into a single incident", + "value": "AnyAlert" + }, + { + "description": "Grouping alerts into a single incident if the selected entities, custom details and alert details match", + "value": "Selected" + } + ] + } + }, + "groupByEntities": { + "description": "A list of entity types to group by (when matchingMethod is Selected). Only entities defined in the current alert rule may be used.", + "items": { + "$ref": "#/definitions/EntityMappingType" + }, + "type": "array" + }, + "groupByAlertDetails": { + "description": "A list of alert details to group by (when matchingMethod is Selected)", + "items": { + "description": "Alert detail", + "enum": [ + "DisplayName", + "Severity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertDetail", + "values": [ + { + "description": "Alert display name", + "value": "DisplayName" + }, + { + "description": "Alert severity", + "value": "Severity" + } + ] + } + }, + "type": "array" + }, + "groupByCustomDetails": { + "description": "A list of custom details keys to group by (when matchingMethod is Selected). Only keys defined in the current alert rule may be used.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "enabled", + "reopenClosedIncident", + "lookbackDuration", + "matchingMethod" + ] + }, + "ActionRequest": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Action for alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ActionRequestProperties", + "description": "Action properties for put request", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "ActionPropertiesBase": { + "description": "Action property bag base.", + "properties": { + "logicAppResourceId": { + "description": "Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}.", + "type": "string" + } + }, + "required": [ + "logicAppResourceId" + ], + "type": "object" + }, + "ActionRequestProperties": { + "allOf": [ + { + "$ref": "#/definitions/ActionPropertiesBase" + } + ], + "description": "Action property bag.", + "properties": { + "triggerUri": { + "description": "Logic App Callback URL for this specific workflow.", + "type": "string", + "x-ms-secret": true + } + }, + "required": [ + "triggerUri" + ], + "type": "object" + }, + "ActionResponse": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Action for alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ActionResponseProperties", + "description": "Action properties for get request", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "ActionResponseProperties": { + "allOf": [ + { + "$ref": "#/definitions/ActionPropertiesBase" + } + ], + "description": "Action property bag.", + "properties": { + "workflowId": { + "description": "The name of the logic app's workflow.", + "type": "string" + } + }, + "type": "object" + }, + "ActionsList": { + "description": "List all the actions.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of actions.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of actions.", + "items": { + "$ref": "#/definitions/ActionResponse" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "EntityMappingType": { + "description": "The V3 type of the mapped entity", + "enum": [ + "Account", + "Host", + "IP", + "Malware", + "File", + "Process", + "CloudApplication", + "DNS", + "AzureResource", + "FileHash", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "URL", + "Mailbox", + "MailCluster", + "MailMessage", + "SubmissionMail" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityMappingType", + "values": [ + { + "description": "User account entity type", + "value": "Account" + }, + { + "description": "Host entity type", + "value": "Host" + }, + { + "description": "IP address entity type", + "value": "IP" + }, + { + "description": "Malware entity type", + "value": "Malware" + }, + { + "description": "System file entity type", + "value": "File" + }, + { + "description": "Process entity type", + "value": "Process" + }, + { + "description": "Cloud app entity type", + "value": "CloudApplication" + }, + { + "description": "DNS entity type", + "value": "DNS" + }, + { + "description": "Azure resource entity type", + "value": "AzureResource" + }, + { + "description": "File-hash entity type", + "value": "FileHash" + }, + { + "description": "Registry key entity type", + "value": "RegistryKey" + }, + { + "description": "Registry value entity type", + "value": "RegistryValue" + }, + { + "description": "Security group entity type", + "value": "SecurityGroup" + }, + { + "description": "URL entity type", + "value": "URL" + }, + { + "description": "Mailbox entity type", + "value": "Mailbox" + }, + { + "description": "Mail cluster entity type", + "value": "MailCluster" + }, + { + "description": "Mail message entity type", + "value": "MailMessage" + }, + { + "description": "Submission mail entity type", + "value": "SubmissionMail" + } + ] + } + }, + "AlertProperty": { + "description": "The V3 alert property", + "enum": [ + "AlertLink", + "ConfidenceLevel", + "ConfidenceScore", + "ExtendedLinks", + "ProductName", + "ProviderName", + "ProductComponentName", + "RemediationSteps", + "Techniques" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertProperty", + "values": [ + { + "description": "Alert's link", + "value": "AlertLink" + }, + { + "description": "Confidence level property", + "value": "ConfidenceLevel" + }, + { + "description": "Confidence score", + "value": "ConfidenceScore" + }, + { + "description": "Extended links to the alert", + "value": "ExtendedLinks" + }, + { + "description": "Product name alert property", + "value": "ProductName" + }, + { + "description": "Provider name alert property", + "value": "ProviderName" + }, + { + "description": "Product component name alert property", + "value": "ProductComponentName" + }, + { + "description": "Remediation steps alert property", + "value": "RemediationSteps" + }, + { + "description": "Techniques alert property", + "value": "Techniques" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/AutomationRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/AutomationRules.json new file mode 100644 index 000000000000..ee06d3b4aa91 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/AutomationRules.json @@ -0,0 +1,1495 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-05-01-preview" + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules/{automationRuleId}": { + "get": { + "tags": [ + "automationRules" + ], + "description": "Gets the automation rule.", + "operationId": "AutomationRules_Get", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AutomationRuleId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AutomationRules_Get": { + "$ref": "./examples/automationRules/AutomationRules_Get.json" + } + } + }, + "put": { + "tags": [ + "automationRules" + ], + "description": "Creates or updates the automation rule.", + "operationId": "AutomationRules_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AutomationRuleId" + }, + { + "in": "body", + "name": "automationRuleToUpsert", + "description": "The automation rule", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AutomationRules_CreateOrUpdate": { + "$ref": "./examples/automationRules/AutomationRules_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "automationRules" + ], + "description": "Delete the automation rule.", + "operationId": "AutomationRules_Delete", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AutomationRuleId" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "type": "object" + } + }, + "204": { + "description": "No Content", + "schema": { + "type": "object" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AutomationRules_Delete": { + "$ref": "./examples/automationRules/AutomationRules_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/automationRules": { + "get": { + "tags": [ + "automationRules" + ], + "description": "Gets all automation rules.", + "operationId": "AutomationRules_List", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "Ok", + "schema": { + "$ref": "#/definitions/AutomationRulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AutomationRules_List": { + "$ref": "./examples/automationRules/AutomationRules_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityIdentifier}/runPlaybook": { + "post": { + "tags": [ + "manualTrigger" + ], + "description": "Triggers playbook on a specific entity.", + "operationId": "Entities_RunPlaybook", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "entityIdentifier", + "description": "Entity identifier.", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "requestBody", + "description": "Describes the request body for triggering a playbook on an entity.", + "schema": { + "$ref": "#/definitions/EntityManualTriggerRequestBody" + } + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Entities_RunPlaybook": { + "$ref": "./examples/manualTrigger/Entities_RunPlaybook.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentIdentifier}/runPlaybook": { + "post": { + "tags": [ + "manualTrigger" + ], + "description": "Triggers playbook on a specific incident", + "operationId": "Incidents_RunPlaybook", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "in": "path", + "name": "incidentIdentifier", + "required": true, + "type": "string" + }, + { + "in": "body", + "name": "requestBody", + "schema": { + "$ref": "#/definitions/ManualTriggerRequestBody" + } + } + ], + "responses": { + "204": { + "description": "Success", + "schema": { + "type": "object" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_RunPlaybook": { + "$ref": "./examples/manualTrigger/Incidents_RunPlaybook.json" + } + } + } + } + }, + "definitions": { + "ActionType": { + "description": "The type of the automation rule action.", + "enum": [ + "ModifyProperties", + "RunPlaybook", + "AddIncidentTask" + ], + "type": "string", + "example": "ModifyProperties", + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true, + "values": [ + { + "value": "ModifyProperties", + "description": "Modify an object's properties" + }, + { + "value": "RunPlaybook", + "description": "Run a playbook on an object" + }, + { + "value": "AddIncidentTask", + "description": "Add a task to an incident object" + } + ] + } + }, + "AddIncidentTaskActionProperties": { + "required": [ + "title" + ], + "type": "object", + "properties": { + "title": { + "description": "The title of the task.", + "type": "string" + }, + "description": { + "description": "The description of the task.", + "type": "string" + } + } + }, + "AutomationRule": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/AutomationRuleProperties", + "x-ms-client-flatten": true + } + } + }, + "AutomationRuleAction": { + "description": "Describes an automation rule action.", + "required": [ + "actionType", + "order" + ], + "type": "object", + "properties": { + "order": { + "format": "int32", + "type": "integer" + }, + "actionType": { + "$ref": "#/definitions/ActionType" + } + }, + "discriminator": "actionType" + }, + "AutomationRuleAddIncidentTaskAction": { + "description": "Describes an automation rule action to add a task to an incident", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleAction" + } + ], + "properties": { + "actionConfiguration": { + "type": "object", + "$ref": "#/definitions/AddIncidentTaskActionProperties" + } + }, + "x-ms-discriminator-value": "AddIncidentTask", + "x-ms-client-flatten": true + }, + "AutomationRuleBooleanCondition": { + "type": "object", + "properties": { + "operator": { + "$ref": "#/definitions/AutomationRuleBooleanConditionSupportedOperator" + }, + "innerConditions": { + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRuleCondition" + }, + "x-ms-identifiers": [], + "minItems": 2, + "maxItems": 10 + } + } + }, + "AutomationRuleBooleanConditionSupportedOperator": { + "enum": [ + "And", + "Or" + ], + "type": "string", + "example": "And", + "x-ms-enum": { + "name": "AutomationRuleBooleanConditionSupportedOperator", + "modelAsString": true, + "values": [ + { + "value": "And", + "description": "Evaluates as true if all the item conditions are evaluated as true" + }, + { + "value": "Or", + "description": "Evaluates as true if at least one of the item conditions are evaluated as true" + } + ] + } + }, + "AutomationRuleCondition": { + "description": "Describes an automation rule condition.", + "required": [ + "conditionType" + ], + "type": "object", + "properties": { + "conditionType": { + "$ref": "#/definitions/ConditionType" + } + }, + "discriminator": "conditionType" + }, + "AutomationRuleModifyPropertiesAction": { + "description": "Describes an automation rule action to modify an object's properties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleAction" + } + ], + "properties": { + "actionConfiguration": { + "type": "object", + "$ref": "#/definitions/IncidentPropertiesAction" + } + }, + "x-ms-discriminator-value": "ModifyProperties", + "x-ms-client-flatten": true + }, + "AutomationRuleProperties": { + "description": "Automation rule properties", + "required": [ + "actions", + "displayName", + "order", + "triggeringLogic" + ], + "type": "object", + "properties": { + "displayName": { + "description": "The display name of the automation rule.", + "type": "string", + "maxLength": 500 + }, + "order": { + "format": "int32", + "description": "The order of execution of the automation rule.", + "type": "integer", + "minimum": 1, + "maximum": 1000 + }, + "triggeringLogic": { + "$ref": "#/definitions/AutomationRuleTriggeringLogic" + }, + "actions": { + "description": "The actions to execute when the automation rule is triggered.", + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRuleAction" + }, + "x-ms-identifiers": [], + "maxItems": 20 + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "The last time the automation rule was updated.", + "type": "string", + "readOnly": true + }, + "createdTimeUtc": { + "format": "date-time", + "description": "The time the automation rule was created.", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "readOnly": true, + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo" + }, + "createdBy": { + "readOnly": true, + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo" + } + } + }, + "AutomationRulePropertyArrayChangedConditionSupportedArrayType": { + "enum": [ + "Alerts", + "Labels", + "Tactics", + "Comments" + ], + "type": "string", + "example": "Alerts", + "x-ms-enum": { + "name": "AutomationRulePropertyArrayChangedConditionSupportedArrayType", + "modelAsString": true, + "values": [ + { + "value": "Alerts", + "description": "Evaluate the condition on the alerts" + }, + { + "value": "Labels", + "description": "Evaluate the condition on the labels" + }, + { + "value": "Tactics", + "description": "Evaluate the condition on the tactics" + }, + { + "value": "Comments", + "description": "Evaluate the condition on the comments" + } + ] + } + }, + "AutomationRulePropertyArrayChangedConditionSupportedChangeType": { + "enum": [ + "Added" + ], + "type": "string", + "example": "Added", + "x-ms-enum": { + "name": "AutomationRulePropertyArrayChangedConditionSupportedChangeType", + "modelAsString": true, + "values": [ + { + "value": "Added", + "description": "Evaluate the condition on items added to the array" + } + ] + } + }, + "AutomationRulePropertyArrayChangedValuesCondition": { + "type": "object", + "properties": { + "arrayType": { + "$ref": "#/definitions/AutomationRulePropertyArrayChangedConditionSupportedArrayType" + }, + "changeType": { + "$ref": "#/definitions/AutomationRulePropertyArrayChangedConditionSupportedChangeType" + } + } + }, + "AutomationRulePropertyArrayConditionSupportedArrayConditionType": { + "enum": [ + "AnyItem" + ], + "type": "string", + "example": "AnyItem", + "x-ms-enum": { + "name": "AutomationRulePropertyArrayConditionSupportedArrayConditionType", + "modelAsString": true, + "values": [ + { + "value": "AnyItem", + "description": "Evaluate the condition as true if any item fulfills it" + } + ] + } + }, + "AutomationRulePropertyArrayConditionSupportedArrayType": { + "enum": [ + "CustomDetails", + "CustomDetailValues" + ], + "type": "string", + "example": "CustomDetails", + "x-ms-enum": { + "name": "AutomationRulePropertyArrayConditionSupportedArrayType", + "modelAsString": true, + "values": [ + { + "value": "CustomDetails", + "description": "Evaluate the condition on the custom detail keys" + }, + { + "value": "CustomDetailValues", + "description": "Evaluate the condition on a custom detail's values" + } + ] + } + }, + "AutomationRulePropertyArrayValuesCondition": { + "type": "object", + "properties": { + "arrayType": { + "$ref": "#/definitions/AutomationRulePropertyArrayConditionSupportedArrayType" + }, + "arrayConditionType": { + "$ref": "#/definitions/AutomationRulePropertyArrayConditionSupportedArrayConditionType" + }, + "itemConditions": { + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRuleCondition" + }, + "x-ms-identifiers": [], + "maxItems": 10 + } + } + }, + "AutomationRulePropertyChangedConditionSupportedChangedType": { + "enum": [ + "ChangedFrom", + "ChangedTo" + ], + "type": "string", + "example": "ChangedFrom", + "x-ms-enum": { + "name": "AutomationRulePropertyChangedConditionSupportedChangedType", + "modelAsString": true, + "values": [ + { + "value": "ChangedFrom", + "description": "Evaluate the condition on the previous value of the property" + }, + { + "value": "ChangedTo", + "description": "Evaluate the condition on the updated value of the property" + } + ] + } + }, + "AutomationRulePropertyChangedConditionSupportedPropertyType": { + "enum": [ + "IncidentSeverity", + "IncidentStatus", + "IncidentOwner" + ], + "type": "string", + "example": "IncidentSeverity", + "x-ms-enum": { + "name": "AutomationRulePropertyChangedConditionSupportedPropertyType", + "modelAsString": true, + "values": [ + { + "value": "IncidentSeverity", + "description": "Evaluate the condition on the incident severity" + }, + { + "value": "IncidentStatus", + "description": "Evaluate the condition on the incident status" + }, + { + "value": "IncidentOwner", + "description": "Evaluate the condition on the incident owner" + } + ] + } + }, + "AutomationRulePropertyConditionSupportedOperator": { + "enum": [ + "Equals", + "NotEquals", + "Contains", + "NotContains", + "StartsWith", + "NotStartsWith", + "EndsWith", + "NotEndsWith" + ], + "type": "string", + "example": "Equals", + "x-ms-enum": { + "name": "AutomationRulePropertyConditionSupportedOperator", + "modelAsString": true, + "values": [ + { + "value": "Equals", + "description": "Evaluates if the property equals at least one of the condition values" + }, + { + "value": "NotEquals", + "description": "Evaluates if the property does not equal any of the condition values" + }, + { + "value": "Contains", + "description": "Evaluates if the property contains at least one of the condition values" + }, + { + "value": "NotContains", + "description": "Evaluates if the property does not contain any of the condition values" + }, + { + "value": "StartsWith", + "description": "Evaluates if the property starts with any of the condition values" + }, + { + "value": "NotStartsWith", + "description": "Evaluates if the property does not start with any of the condition values" + }, + { + "value": "EndsWith", + "description": "Evaluates if the property ends with any of the condition values" + }, + { + "value": "NotEndsWith", + "description": "Evaluates if the property does not end with any of the condition values" + } + ] + } + }, + "AutomationRulePropertyConditionSupportedProperty": { + "description": "The property to evaluate in an automation rule property condition.", + "enum": [ + "IncidentTitle", + "IncidentDescription", + "IncidentSeverity", + "IncidentStatus", + "IncidentRelatedAnalyticRuleIds", + "IncidentTactics", + "IncidentLabel", + "IncidentProviderName", + "IncidentUpdatedBySource", + "IncidentCustomDetailsKey", + "IncidentCustomDetailsValue", + "AccountAadTenantId", + "AccountAadUserId", + "AccountName", + "AccountNTDomain", + "AccountPUID", + "AccountSid", + "AccountObjectGuid", + "AccountUPNSuffix", + "AlertProductNames", + "AlertAnalyticRuleIds", + "AzureResourceResourceId", + "AzureResourceSubscriptionId", + "CloudApplicationAppId", + "CloudApplicationAppName", + "DNSDomainName", + "FileDirectory", + "FileName", + "FileHashValue", + "HostAzureID", + "HostName", + "HostNetBiosName", + "HostNTDomain", + "HostOSVersion", + "IoTDeviceId", + "IoTDeviceName", + "IoTDeviceType", + "IoTDeviceVendor", + "IoTDeviceModel", + "IoTDeviceOperatingSystem", + "IPAddress", + "MailboxDisplayName", + "MailboxPrimaryAddress", + "MailboxUPN", + "MailMessageDeliveryAction", + "MailMessageDeliveryLocation", + "MailMessageRecipient", + "MailMessageSenderIP", + "MailMessageSubject", + "MailMessageP1Sender", + "MailMessageP2Sender", + "MalwareCategory", + "MalwareName", + "ProcessCommandLine", + "ProcessId", + "RegistryKey", + "RegistryValueData", + "Url" + ], + "type": "string", + "example": "IncidentTitle", + "x-ms-enum": { + "name": "AutomationRulePropertyConditionSupportedProperty", + "modelAsString": true, + "values": [ + { + "value": "IncidentTitle", + "description": "The title of the incident" + }, + { + "value": "IncidentDescription", + "description": "The description of the incident" + }, + { + "value": "IncidentSeverity", + "description": "The severity of the incident" + }, + { + "value": "IncidentStatus", + "description": "The status of the incident" + }, + { + "value": "IncidentRelatedAnalyticRuleIds", + "description": "The related Analytic rule ids of the incident" + }, + { + "value": "IncidentTactics", + "description": "The tactics of the incident" + }, + { + "value": "IncidentLabel", + "description": "The labels of the incident" + }, + { + "value": "IncidentProviderName", + "description": "The provider name of the incident" + }, + { + "value": "IncidentUpdatedBySource", + "description": "The update source of the incident" + }, + { + "value": "IncidentCustomDetailsKey", + "description": "The incident custom detail key" + }, + { + "value": "IncidentCustomDetailsValue", + "description": "The incident custom detail value" + }, + { + "value": "AccountAadTenantId", + "description": "The account Azure Active Directory tenant id" + }, + { + "value": "AccountAadUserId", + "description": "The account Azure Active Directory user id" + }, + { + "value": "AccountName", + "description": "The account name" + }, + { + "value": "AccountNTDomain", + "description": "The account NetBIOS domain name" + }, + { + "value": "AccountPUID", + "description": "The account Azure Active Directory Passport User ID" + }, + { + "value": "AccountSid", + "description": "The account security identifier" + }, + { + "value": "AccountObjectGuid", + "description": "The account unique identifier" + }, + { + "value": "AccountUPNSuffix", + "description": "The account user principal name suffix" + }, + { + "value": "AlertProductNames", + "description": "The name of the product of the alert" + }, + { + "value": "AlertAnalyticRuleIds", + "description": "The analytic rule ids of the alert" + }, + { + "value": "AzureResourceResourceId", + "description": "The Azure resource id" + }, + { + "value": "AzureResourceSubscriptionId", + "description": "The Azure resource subscription id" + }, + { + "value": "CloudApplicationAppId", + "description": "The cloud application identifier" + }, + { + "value": "CloudApplicationAppName", + "description": "The cloud application name" + }, + { + "value": "DNSDomainName", + "description": "The dns record domain name" + }, + { + "value": "FileDirectory", + "description": "The file directory full path" + }, + { + "value": "FileName", + "description": "The file name without path" + }, + { + "value": "FileHashValue", + "description": "The file hash value" + }, + { + "value": "HostAzureID", + "description": "The host Azure resource id" + }, + { + "value": "HostName", + "description": "The host name without domain" + }, + { + "value": "HostNetBiosName", + "description": "The host NetBIOS name" + }, + { + "value": "HostNTDomain", + "description": "The host NT domain" + }, + { + "value": "HostOSVersion", + "description": "The host operating system" + }, + { + "value": "IoTDeviceId", + "description": "\"The IoT device id" + }, + { + "value": "IoTDeviceName", + "description": "The IoT device name" + }, + { + "value": "IoTDeviceType", + "description": "The IoT device type" + }, + { + "value": "IoTDeviceVendor", + "description": "The IoT device vendor" + }, + { + "value": "IoTDeviceModel", + "description": "The IoT device model" + }, + { + "value": "IoTDeviceOperatingSystem", + "description": "The IoT device operating system" + }, + { + "value": "IPAddress", + "description": "The IP address" + }, + { + "value": "MailboxDisplayName", + "description": "The mailbox display name" + }, + { + "value": "MailboxPrimaryAddress", + "description": "The mailbox primary address" + }, + { + "value": "MailboxUPN", + "description": "The mailbox user principal name" + }, + { + "value": "MailMessageDeliveryAction", + "description": "The mail message delivery action" + }, + { + "value": "MailMessageDeliveryLocation", + "description": "The mail message delivery location" + }, + { + "value": "MailMessageRecipient", + "description": "The mail message recipient" + }, + { + "value": "MailMessageSenderIP", + "description": "The mail message sender IP address" + }, + { + "value": "MailMessageSubject", + "description": "The mail message subject" + }, + { + "value": "MailMessageP1Sender", + "description": "The mail message P1 sender" + }, + { + "value": "MailMessageP2Sender", + "description": "The mail message P2 sender" + }, + { + "value": "MalwareCategory", + "description": "The malware category" + }, + { + "value": "MalwareName", + "description": "The malware name" + }, + { + "value": "ProcessCommandLine", + "description": "The process execution command line" + }, + { + "value": "ProcessId", + "description": "The process id" + }, + { + "value": "RegistryKey", + "description": "The registry key path" + }, + { + "value": "RegistryValueData", + "description": "The registry key value in string formatted representation" + }, + { + "value": "Url", + "description": "The url" + } + ] + } + }, + "AutomationRulePropertyValuesChangedCondition": { + "type": "object", + "properties": { + "propertyName": { + "$ref": "#/definitions/AutomationRulePropertyChangedConditionSupportedPropertyType" + }, + "changeType": { + "$ref": "#/definitions/AutomationRulePropertyChangedConditionSupportedChangedType" + }, + "operator": { + "$ref": "#/definitions/AutomationRulePropertyConditionSupportedOperator" + }, + "propertyValues": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AutomationRulePropertyValuesCondition": { + "type": "object", + "properties": { + "propertyName": { + "$ref": "#/definitions/AutomationRulePropertyConditionSupportedProperty" + }, + "operator": { + "$ref": "#/definitions/AutomationRulePropertyConditionSupportedOperator" + }, + "propertyValues": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AutomationRuleRunPlaybookAction": { + "description": "Describes an automation rule action to run a playbook", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleAction" + } + ], + "properties": { + "actionConfiguration": { + "type": "object", + "$ref": "#/definitions/PlaybookActionProperties" + } + }, + "x-ms-discriminator-value": "RunPlaybook", + "x-ms-client-flatten": true + }, + "AutomationRulesList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AutomationRule" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "AutomationRuleTriggeringLogic": { + "description": "Describes automation rule triggering logic.", + "required": [ + "isEnabled", + "triggersOn", + "triggersWhen" + ], + "type": "object", + "properties": { + "isEnabled": { + "description": "Determines whether the automation rule is enabled or disabled.", + "type": "boolean" + }, + "expirationTimeUtc": { + "format": "date-time", + "description": "Determines when the automation rule should automatically expire and be disabled.", + "type": "string" + }, + "triggersOn": { + "$ref": "#/definitions/triggersOn" + }, + "triggersWhen": { + "$ref": "#/definitions/triggersWhen" + }, + "conditions": { + "description": "The conditions to evaluate to determine if the automation rule should be triggered on a given object.", + "type": "array", + "maxItems": 50, + "items": { + "$ref": "#/definitions/AutomationRuleCondition" + }, + "x-ms-identifiers": [ + "conditionType" + ] + } + } + }, + "BooleanConditionProperties": { + "description": "Describes an automation rule condition that applies a boolean operator (e.g AND, OR) to conditions", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRuleBooleanCondition" + } + }, + "x-ms-discriminator-value": "Boolean", + "x-ms-client-flatten": true + }, + "ConditionType": { + "enum": [ + "Property", + "PropertyArray", + "PropertyChanged", + "PropertyArrayChanged", + "Boolean" + ], + "type": "string", + "example": "Property", + "x-ms-enum": { + "name": "ConditionType", + "modelAsString": true, + "values": [ + { + "value": "Property", + "description": "Evaluate an object property value" + }, + { + "value": "PropertyArray", + "description": "Evaluate an object array property value" + }, + { + "value": "PropertyChanged", + "description": "Evaluate an object property changed value" + }, + { + "value": "PropertyArrayChanged", + "description": "Evaluate an object array property changed value" + }, + { + "value": "Boolean", + "description": "Apply a boolean operator (e.g AND, OR) to conditions" + } + ] + } + }, + "EntityManualTriggerRequestBody": { + "type": "object", + "description": "Describes the request body for triggering a playbook on an entity.", + "required": [ + "logicAppsResourceId" + ], + "properties": { + "incidentArmId": { + "type": "string", + "description": "Incident ARM id." + }, + "tenantId": { + "format": "uuid", + "type": "string", + "description": "The tenant id of the playbook resource." + }, + "logicAppsResourceId": { + "type": "string", + "description": "The resource id of the playbook resource." + } + } + }, + "IncidentPropertiesAction": { + "type": "object", + "properties": { + "severity": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentSeverityEnum" + }, + "status": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentStatusEnum" + }, + "classification": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentClassificationEnum" + }, + "classificationReason": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentClassificationReasonEnum" + }, + "classificationComment": { + "description": "Describes the reason the incident was closed.", + "type": "string" + }, + "owner": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentOwnerInfo" + }, + "labels": { + "description": "List of labels to add to the incident.", + "type": "array", + "x-ms-identifiers": [ + "labelName" + ], + "items": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentLabel" + } + } + } + }, + "ManualTriggerRequestBody": { + "type": "object", + "required": [ + "logicAppsResourceId" + ], + "properties": { + "tenantId": { + "format": "uuid", + "type": "string" + }, + "logicAppsResourceId": { + "type": "string" + } + } + }, + "PlaybookActionProperties": { + "type": "object", + "required": [ + "logicAppResourceId" + ], + "properties": { + "logicAppResourceId": { + "description": "The resource id of the playbook resource.", + "type": "string" + }, + "tenantId": { + "format": "uuid", + "description": "The tenant id of the playbook resource.", + "type": "string" + } + } + }, + "PropertyArrayChangedConditionProperties": { + "description": "Describes an automation rule condition that evaluates an array property's value change", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRulePropertyArrayChangedValuesCondition" + } + }, + "x-ms-discriminator-value": "PropertyArrayChanged", + "x-ms-client-flatten": true + }, + "PropertyArrayConditionProperties": { + "description": "Describes an automation rule condition that evaluates an array property's value", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRulePropertyArrayValuesCondition" + } + }, + "x-ms-discriminator-value": "PropertyArray", + "x-ms-client-flatten": true + }, + "PropertyChangedConditionProperties": { + "description": "Describes an automation rule condition that evaluates a property's value change", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRulePropertyValuesChangedCondition" + } + }, + "x-ms-discriminator-value": "PropertyChanged", + "x-ms-client-flatten": true + }, + "PropertyConditionProperties": { + "description": "Describes an automation rule condition that evaluates a property's value", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AutomationRuleCondition" + } + ], + "properties": { + "conditionProperties": { + "type": "object", + "$ref": "#/definitions/AutomationRulePropertyValuesCondition" + } + }, + "x-ms-discriminator-value": "Property", + "x-ms-client-flatten": true + }, + "triggersOn": { + "enum": [ + "Incidents", + "Alerts" + ], + "type": "string", + "example": "Incidents", + "x-ms-enum": { + "name": "triggersOn", + "modelAsString": true, + "values": [ + { + "value": "Incidents", + "description": "Trigger on Incidents" + }, + { + "value": "Alerts", + "description": "Trigger on Alerts" + } + ] + } + }, + "triggersWhen": { + "enum": [ + "Created", + "Updated" + ], + "type": "string", + "example": "Created", + "x-ms-enum": { + "name": "triggersWhen", + "modelAsString": true, + "values": [ + { + "value": "Created", + "description": "Trigger on created objects" + }, + { + "value": "Updated", + "description": "Trigger on updated objects" + } + ] + } + } + }, + "parameters": { + "AutomationRule": { + "name": "automationRule", + "description": "The automation rule", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/AutomationRule" + } + }, + "AutomationRuleId": { + "in": "path", + "name": "automationRuleId", + "description": "Automation rule ID", + "required": true, + "x-ms-parameter-location": "method", + "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" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/BillingStatistics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/BillingStatistics.json new file mode 100644 index 000000000000..c743e063f744 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/BillingStatistics.json @@ -0,0 +1,226 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/billingStatistics": { + "get": { + "x-ms-examples": { + "Get all Microsoft Sentinel billing statistics.": { + "$ref": "./examples/billingStatistics/GetAllBillingStatistics.json" + } + }, + "tags": [ + "billingStatistics" + ], + "description": "Gets all Microsoft Sentinel billing statistics.", + "operationId": "BillingStatistics_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BillingStatisticList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/billingStatistics/{billingStatisticName}": { + "get": { + "x-ms-examples": { + "Get a billing statistic.": { + "$ref": "./examples/billingStatistics/GetBillingStatistic.json" + } + }, + "tags": [ + "billingStatistics" + ], + "description": "Gets a billing statistic", + "operationId": "BillingStatistics_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BillingStatisticName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BillingStatistic" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "BillingStatisticList": { + "description": "List of all Microsoft Sentinel billing statistics.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of billing statistics.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of billing statistics.", + "items": { + "$ref": "#/definitions/BillingStatistic" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "BillingStatistic": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/AzureEntityResource" + } + ], + "description": "Billing statistic", + "properties": { + "kind": { + "$ref": "#/definitions/BillingStatisticKindEnum", + "description": "The kind of the billing statistic" + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "BillingStatisticKindEnum": { + "description": "The kind of the billing statistic", + "enum": [ + "SapSolutionUsage" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "BillingStatisticKind", + "values": [ + { + "value": "SapSolutionUsage" + } + ] + } + }, + "SapSolutionUsageStatistic": { + "allOf": [ + { + "$ref": "#/definitions/BillingStatistic" + } + ], + "description": "Billing statistic about the Microsoft Sentinel solution for SAP Usage", + "properties": { + "properties": { + "$ref": "#/definitions/SapSolutionUsageStatisticProperties", + "description": "The SAP solution usage object", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SapSolutionUsage" + }, + "SapSolutionUsageStatisticProperties": { + "description": "Properties of the billing statistic about the Microsoft Sentinel solution for SAP usage", + "properties": { + "activeSystemIdCount": { + "description": "The latest count of active SAP system IDs under the Microsoft Sentinel solution for SAP Usage", + "type": "integer", + "format": "int64", + "readOnly": true + } + }, + "type": "object" + } + }, + "parameters": { + "BillingStatisticName": { + "description": "The name of the billing statistic", + "in": "path", + "name": "billingStatisticName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Bookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Bookmarks.json new file mode 100644 index 000000000000..a3bb8ab87a39 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Bookmarks.json @@ -0,0 +1,751 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks": { + "get": { + "x-ms-examples": { + "Get all bookmarks.": { + "$ref": "./examples/bookmarks/GetBookmarks.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Gets all bookmarks.", + "operationId": "Bookmarks_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}": { + "get": { + "x-ms-examples": { + "Get a bookmark.": { + "$ref": "./examples/bookmarks/GetBookmarkById.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Gets a bookmark.", + "operationId": "Bookmarks_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a bookmark.": { + "$ref": "./examples/bookmarks/CreateBookmark.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Creates or updates the bookmark.", + "operationId": "Bookmarks_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "#/parameters/Bookmark" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a bookmark.": { + "$ref": "./examples/bookmarks/DeleteBookmark.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Delete the bookmark.", + "operationId": "Bookmarks_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations": { + "get": { + "x-ms-examples": { + "Get all bookmark relations.": { + "$ref": "./examples/bookmarks/relations/GetAllBookmarkRelations.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Gets all bookmark relations.", + "operationId": "BookmarkRelations_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/RelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "./common/RelationTypes.json#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/expand": { + "post": { + "x-ms-examples": { + "Expand an bookmark": { + "$ref": "./examples/bookmarks/expand/PostExpandBookmark.json" + } + }, + "description": "Expand an bookmark", + "operationId": "Bookmark_Expand", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "#/parameters/BookmarkExpandRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/BookmarkExpandResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "tags": [ + "Bookmark" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get a bookmark relation.": { + "$ref": "./examples/bookmarks/relations/GetBookmarkRelationByName.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Gets a bookmark relation.", + "operationId": "BookmarkRelations_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a bookmark relation.": { + "$ref": "./examples/bookmarks/relations/CreateBookmarkRelation.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Creates the bookmark relation.", + "operationId": "BookmarkRelations_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/Relation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the bookmark relation.": { + "$ref": "./examples/bookmarks/relations/DeleteBookmarkRelation.json" + } + }, + "tags": [ + "BookmarkRelations" + ], + "description": "Delete the bookmark relation.", + "operationId": "BookmarkRelations_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "Bookmark": { + "description": "The bookmark", + "in": "body", + "name": "bookmark", + "required": true, + "schema": { + "$ref": "#/definitions/Bookmark" + }, + "x-ms-parameter-location": "method" + }, + "BookmarkExpandRequestBody": { + "description": "The parameters required to execute an expand operation on the given bookmark.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/BookmarkExpandParameters" + }, + "x-ms-parameter-location": "method" + }, + "BookmarkId": { + "description": "Bookmark ID", + "in": "path", + "name": "bookmarkId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Bookmark": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a bookmark in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/BookmarkProperties", + "description": "Bookmark properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "BookmarkExpandParameters": { + "description": "The parameters required to execute an expand operation on the given bookmark.", + "properties": { + "endTime": { + "description": "The end date filter, so the only expansion results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "expansionId": { + "description": "The Id of the expansion to perform.", + "format": "uuid", + "type": "string" + }, + "startTime": { + "description": "The start date filter, so the only expansion results returned are after this date.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "BookmarkExpandResponse": { + "description": "The entity expansion result operation response.", + "properties": { + "metaData": { + "$ref": "./common/EntityTypes.json#/definitions/ExpansionResultsMetadata", + "description": "The metadata from the expansion operation results." + }, + "value": { + "description": "The expansion result values.", + "properties": { + "entities": { + "description": "Array of the expansion result entities.", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/Entity" + }, + "type": "array" + }, + "edges": { + "description": "Array of expansion result connected entities", + "items": { + "$ref": "#/definitions/ConnectedEntity" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "type": "object" + }, + "BookmarkList": { + "description": "List all the bookmarks.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of bookmarks.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of bookmarks.", + "items": { + "$ref": "#/definitions/Bookmark" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "BookmarkProperties": { + "description": "Describes bookmark properties", + "properties": { + "created": { + "description": "The time the bookmark was created", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "displayName": { + "description": "The display name of the bookmark", + "type": "string" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array" + }, + "notes": { + "description": "The notes of the bookmark", + "type": "string" + }, + "query": { + "description": "The query of the bookmark.", + "type": "string" + }, + "queryResult": { + "description": "The query result of the bookmark.", + "type": "string" + }, + "updated": { + "description": "The last time the bookmark was updated", + "format": "date-time", + "type": "string" + }, + "updatedBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "eventTime": { + "description": "The bookmark event time", + "format": "date-time", + "type": "string" + }, + "queryStartTime": { + "description": "The start time for the query", + "format": "date-time", + "type": "string" + }, + "queryEndTime": { + "description": "The end time for the query", + "format": "date-time", + "type": "string" + }, + "incidentInfo": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" + }, + "entityMappings": { + "$ref": "#/definitions/EntityMappingsList", + "description": "Describes the entity mappings of the bookmark", + "type": "object" + }, + "tactics": { + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "description": "A list of relevant mitre attacks", + "type": "array" + }, + "techniques": { + "items": { + "$ref": "#/definitions/AttackTechnique" + }, + "description": "A list of relevant mitre techniques", + "type": "array" + } + }, + "required": [ + "displayName", + "query" + ], + "type": "object" + }, + "ConnectedEntity": { + "description": "Expansion result connected entities", + "properties": { + "targetEntityId": { + "description": "Entity Id of the connected entity", + "type": "string" + }, + "additionalData": { + "description": "key-value pairs for a connected entity mapping", + "type": "object" + } + }, + "type": "object" + }, + "EntityMappingsList": { + "description": "Describes the entity mappings of the bookmark", + "items": { + "$ref": "#/definitions/BookmarkEntityMappings" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "BookmarkEntityMappings": { + "description": "Describes the entity mappings of a single entity", + "properties": { + "entityType": { + "description": "The entity type", + "type": "string" + }, + "fieldMappings": { + "description": "Array of fields mapping for that entity type", + "items": { + "$ref": "#/definitions/EntityFieldMapping" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "type": "object" + }, + "EntityFieldMapping": { + "description": "Map identifiers of a single entity", + "properties": { + "identifier": { + "description": "Alert V3 identifier", + "type": "string" + }, + "value": { + "description": "The value of the identifier", + "type": "string" + } + }, + "type": "object" + }, + "AttackTechnique": { + "description": "Mitre technique (https://attack.mitre.org/matrices/enterprise/)", + "type": "string" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentPackages.json new file mode 100644 index 000000000000..e90aa95f9e68 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentPackages.json @@ -0,0 +1,453 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages": { + "get": { + "x-ms-examples": { + "Get all available packages.": { + "$ref": "./examples/contentPackages/GetPackages.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Gets all installed packages.", + "operationId": "ContentPackages_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/packageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentPackages/{packageId}": { + "get": { + "x-ms-examples": { + "Get installed packages by id.": { + "$ref": "./examples/contentPackages/GetPackageById.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Gets an installed packages by its id.", + "operationId": "ContentPackages_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/packageModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Install a package to the workspace.": { + "$ref": "./examples/contentPackages/InstallPackage.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Install a package to the workspace.", + "operationId": "ContentPackage_Install", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + }, + { + "$ref": "#/parameters/PackageInstallationProperties" + } + ], + "responses": { + "200": { + "description": "OK, a package is updated.", + "schema": { + "$ref": "#/definitions/packageModel" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/packageModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Uninstall a package from the workspace.": { + "$ref": "./examples/contentPackages/UninstallPackage.json" + } + }, + "tags": [ + "ContentPackages" + ], + "description": "Uninstall a package from the workspace.", + "operationId": "ContentPackage_Uninstall", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "packageList": { + "description": "List available packages.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of packages.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of packages.", + "items": { + "$ref": "#/definitions/packageModel" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "packageModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Package in Azure Security Insights.", + "properties": { + "properties": { + "description": "package properties", + "$ref": "#/definitions/packageProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "packageProperties": { + "description": "Describes package properties", + "properties": { + "contentId": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentId", + "description": "The package id" + }, + "contentKind": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataPackageKind", + "description": "The package kind" + }, + "contentSchemaVersion": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion", + "description": "The version of the content schema." + }, + "isNew": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this is a newly published package." + }, + "isPreview": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this package is in preview." + }, + "isFeatured": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this package is among the featured list." + }, + "version": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion", + "description": "the latest version number of the package" + }, + "displayName": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDisplayName", + "description": "The display name of the package" + }, + "description": { + "description": "The description of the package", + "type": "string" + }, + "publisherDisplayName": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDisplayName", + "description": "The publisher display name of the package" + }, + "source": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataSource", + "description": "The source of the package" + }, + "author": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataAuthor", + "description": "The author of the package" + }, + "support": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataSupport", + "description": "The support tier of the package" + }, + "dependencies": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDependencies", + "description": "The support tier of the package" + }, + "providers": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataProviders", + "description": "Providers for the package item" + }, + "firstPublishDate": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataFirstPublishDate", + "description": "first publish date package item" + }, + "lastPublishDate": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataLastPublishDate", + "description": "last publish date for the package item" + }, + "categories": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataCategories", + "description": "The categories of the package" + }, + "threatAnalysisTactics": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "icon": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the content metadata" + } + }, + "required": [ + "contentId", + "contentKind", + "version", + "displayName" + ], + "type": "object" + }, + "metadataDependencies": { + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies.", + "type": "object", + "properties": { + "contentId": { + "description": "Id of the content item we depend on", + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentId" + }, + "kind": { + "description": "Type of the content item we depend on", + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataKind" + }, + "version": { + "description": "Version of the the content item we depend on. Can be blank, * or missing to indicate any version fulfills the dependency. If version does not match our defined numeric format then an exact match is required.", + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion" + }, + "name": { + "description": "Name of the content item", + "type": "string" + }, + "operator": { + "description": "Operator used for list of dependencies in criteria array.", + "type": "string", + "enum": [ + "AND", + "OR" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "operator", + "values": [ + { + "value": "AND" + }, + { + "value": "OR" + } + ] + } + }, + "criteria": { + "description": "This is the list of dependencies we must fulfill, according to the AND/OR operator", + "type": "array", + "items": { + "$ref": "#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "x-ms-identifiers": [], + "example": [ + { + "kind": "DataConnector", + "contentId": "68b1de8a-b635-430d-b208-01ba3dda5877", + "version": "1.0.0" + }, + { + "kind": "Workbook", + "contentId": "ad903b46-9905-4504-9825-3bcce796da8e", + "version": "1.0.0" + } + ] + } + } + } + }, + "parameters": { + "PackageIdParameter": { + "description": "package Id", + "in": "path", + "name": "packageId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PackageInstallationProperties": { + "description": "Package installation properties", + "in": "body", + "name": "packageInstallationProperties", + "required": true, + "schema": { + "$ref": "#/definitions/packageModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentProductPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentProductPackages.json new file mode 100644 index 000000000000..3b061879a84f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentProductPackages.json @@ -0,0 +1,297 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductPackages": { + "get": { + "x-ms-examples": { + "Get all available packages.": { + "$ref": "./examples/contentPackages/GetProductPackages.json" + } + }, + "tags": [ + "ContentProductPackages" + ], + "description": "Gets all packages from the catalog.", + "operationId": "ProductPackages_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/packageList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductPackages/{packageId}": { + "get": { + "x-ms-examples": { + "Get a package.": { + "$ref": "./examples/contentPackages/GetProductPackageById.json" + } + }, + "tags": [ + "ContentProductPackages" + ], + "description": "Gets a package by its identifier from the catalog.", + "operationId": "ProductPackage_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/PackageIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/packageModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "packageList": { + "description": "List available packages.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of packages.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of packages.", + "items": { + "$ref": "#/definitions/packageModel" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "packageModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Package in Azure Security Insights.", + "properties": { + "properties": { + "description": "package properties", + "$ref": "#/definitions/packageProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "packageProperties": { + "description": "Describes package properties", + "properties": { + "contentId": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentId", + "description": "The content id of the package" + }, + "contentKind": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataPackageKind", + "description": "The package kind" + }, + "installedVersion": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion", + "description": "The version of the installed package, null or absent means not installed." + }, + "contentSchemaVersion": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion", + "description": "The version of the content schema." + }, + "resourceId": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentId", + "description": "The metadata resource id." + }, + "isNew": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this is a newly published package." + }, + "isPreview": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this package is in preview." + }, + "isFeatured": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataTrueFalseFlag", + "description": "Flag indicates if this package is among the featured list." + }, + "version": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion", + "description": "the latest version number of the package" + }, + "displayName": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDisplayName", + "description": "The display name of the package" + }, + "description": { + "description": "The description of the package", + "type": "string" + }, + "publisherDisplayName": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDisplayName", + "description": "The publisher display name of the package" + }, + "source": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataSource", + "description": "The source of the package" + }, + "author": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataAuthor", + "description": "The author of the package" + }, + "support": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataSupport", + "description": "The support tier of the package" + }, + "dependencies": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDependencies", + "description": "The support tier of the package" + }, + "providers": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataProviders", + "description": "Providers for the package item" + }, + "firstPublishDate": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataFirstPublishDate", + "description": "first publish date package item" + }, + "lastPublishDate": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataLastPublishDate", + "description": "last publish date for the package item" + }, + "categories": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataCategories", + "description": "The categories of the package" + }, + "threatAnalysisTactics": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "icon": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the content metadata" + }, + "packagedContent": { + "type": "object", + "description": "the json to deploy" + } + }, + "required": [ + "contentId", + "contentKind", + "version", + "displayName" + ], + "type": "object" + } + }, + "parameters": { + "PackageIdParameter": { + "description": "package Id", + "in": "path", + "name": "packageId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentProductTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentProductTemplates.json new file mode 100644 index 000000000000..a6ea3e9cbd97 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentProductTemplates.json @@ -0,0 +1,298 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentProductTemplates": { + "get": { + "x-ms-examples": { + "Get all installed templates.": { + "$ref": "./examples/contentTemplates/GetProductTemplates.json" + } + }, + "tags": [ + "ContentProductTemplates" + ], + "description": "Gets all templates in the catalog.", + "operationId": "ProductTemplates_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/templateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentproducttemplates/{templateId}": { + "get": { + "x-ms-examples": { + "Get a template.": { + "$ref": "./examples/contentTemplates/GetProductTemplateById.json" + } + }, + "tags": [ + "ContentProductTemplates" + ], + "description": "Gets a template by its identifier.", + "operationId": "ProductTemplate_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/templateModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "templateList": { + "description": "List of all the template.", + "type": "object", + "properties": { + "value": { + "description": "Array of templates.", + "items": { + "$ref": "#/definitions/templateModel" + }, + "type": "array" + }, + "nextLink": { + "description": "URL to fetch the next page of template.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "templateModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Template resource definition.", + "properties": { + "properties": { + "description": "template properties", + "$ref": "#/definitions/templateProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "templateProperties": { + "description": "Template property bag.", + "required": [ + "contentId", + "version", + "displayName", + "contentKind", + "source" + ], + "type": "object", + "properties": { + "contentId": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentId", + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name" + }, + "parentId": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataParentId", + "description": "Full parent resource ID of the content item the template is for. This is the full resource ID including the scope (subscription and resource group)" + }, + "version": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion", + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM metadata best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "displayName": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDisplayName", + "description": "The display name of the template" + }, + "contentKind": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataKind", + "description": "The kind of content the template is for." + }, + "source": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataSource", + "description": "Source of the content. This is where/how it was created." + }, + "author": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataAuthor", + "description": "The creator of the content item." + }, + "support": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataSupport", + "description": "Support information for the template - type, name, contact information" + }, + "dependencies": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "categories": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataCategories", + "description": "Categories for the item" + }, + "providers": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataProviders", + "description": "Providers for the content item" + }, + "firstPublishDate": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataFirstPublishDate", + "description": "first publish date content item" + }, + "lastPublishDate": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataLastPublishDate", + "description": "last publish date for the content item" + }, + "customVersion": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataCustomVersion", + "description": "The custom version of the content. A optional free text" + }, + "contentSchemaVersion": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentSchemaVersion", + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version" + }, + "icon": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the content metadata" + }, + "threatAnalysisTactics": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "previewImages": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataPreviewImages", + "description": "preview image file names. These will be taken from the solution artifacts" + }, + "previewImagesDark": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataPreviewImagesDark", + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support" + }, + "packageId": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentId", + "description": "the package Id contains this template" + }, + "packageKind": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataPackageKind", + "description": "the packageKind of the package contains this template" + }, + "packageName": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDisplayName", + "description": "the name of the package contains this template" + }, + "packagedContent": { + "type": "object", + "description": "the json to deploy" + } + } + } + }, + "parameters": { + "templateIdParameter": { + "description": "template Id", + "in": "path", + "name": "templateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentTemplates.json new file mode 100644 index 000000000000..0b3067490ba7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentTemplates.json @@ -0,0 +1,400 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentTemplates": { + "get": { + "x-ms-examples": { + "Get all installed templates.": { + "$ref": "./examples/contentTemplates/GetTemplates.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Gets all installed templates.", + "operationId": "ContentTemplates_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/templateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/contentTemplates/{templateId}": { + "put": { + "x-ms-examples": { + "Get a template.": { + "$ref": "./examples/contentTemplates/InstallTemplate.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Install a template.", + "operationId": "ContentTemplate_Install", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + }, + { + "$ref": "#/parameters/templateInstallationProperties" + } + ], + "responses": { + "200": { + "description": "OK, a template is updated.", + "schema": { + "$ref": "#/definitions/templateModel" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/templateModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "get": { + "x-ms-examples": { + "Get a template.": { + "$ref": "./examples/contentTemplates/GetTemplateById.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Gets a template byt its identifier.", + "operationId": "ContentTemplate_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/templateModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete metadata.": { + "$ref": "./examples/contentTemplates/DeleteTemplate.json" + } + }, + "tags": [ + "ContentTemplates" + ], + "description": "Delete an installed template.", + "operationId": "ContentTemplate_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/templateIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "templateList": { + "description": "List of all the template.", + "type": "object", + "properties": { + "value": { + "description": "Array of templates.", + "items": { + "$ref": "#/definitions/templateModel" + }, + "type": "array" + }, + "nextLink": { + "description": "URL to fetch the next page of template.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "templateModel": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Template resource definition.", + "properties": { + "properties": { + "description": "template properties", + "$ref": "#/definitions/templateProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "templateProperties": { + "description": "Template property bag.", + "required": [ + "contentId", + "version", + "displayName", + "contentKind", + "source", + "packageId" + ], + "type": "object", + "properties": { + "contentId": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentId", + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name" + }, + "version": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataVersion", + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM metadata best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "displayName": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDisplayName", + "description": "The display name of the template" + }, + "contentKind": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataKind", + "description": "The kind of content the template is for." + }, + "source": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataSource", + "description": "Source of the content. This is where/how it was created." + }, + "author": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataAuthor", + "description": "The creator of the content item." + }, + "support": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataSupport", + "description": "Support information for the template - type, name, contact information" + }, + "dependencies": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "categories": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataCategories", + "description": "Categories for the item" + }, + "providers": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataProviders", + "description": "Providers for the content item" + }, + "firstPublishDate": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataFirstPublishDate", + "description": "first publish date content item" + }, + "lastPublishDate": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataLastPublishDate", + "description": "last publish date for the content item" + }, + "customVersion": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataCustomVersion", + "description": "The custom version of the content. A optional free text" + }, + "contentSchemaVersion": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentSchemaVersion", + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version" + }, + "icon": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the content metadata" + }, + "threatAnalysisTactics": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "previewImages": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataPreviewImages", + "description": "preview image file names. These will be taken from the solution artifacts" + }, + "previewImagesDark": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataPreviewImagesDark", + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support" + }, + "packageId": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataContentId", + "description": "the package Id contains this template" + }, + "packageKind": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataPackageKind", + "description": "the packageKind of the package contains this template" + }, + "packageName": { + "$ref": "./common/ContentCommonTypes.json#/definitions/metadataDisplayName", + "description": "the name of the package contains this template" + }, + "mainTemplate": { + "description": "The JSON of the ARM template to deploy active content", + "type": "object" + } + } + } + }, + "parameters": { + "templateIdParameter": { + "description": "template Id", + "in": "path", + "name": "templateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "templateInstallationProperties": { + "description": "Template installation properties", + "in": "body", + "name": "templateInstallationProperties", + "required": true, + "schema": { + "$ref": "#/definitions/templateModel" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Enrichment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Enrichment.json new file mode 100644 index 000000000000..bee7fce83c28 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Enrichment.json @@ -0,0 +1,381 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.SecurityInsights/enrichment/ip/geodata/": { + "get": { + "x-ms-examples": { + "Get geodata for a single IP address": { + "$ref": "./examples/enrichment/GetGeodataByIp.json" + } + }, + "tags": [ + "Enrichment" + ], + "description": "Get geodata for a single IP address", + "operationId": "IPGeodata_Get", + "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/EnrichmentIpAddress" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EnrichmentIpGeodata" + } + }, + "default": { + "description": "Error response describing why the operation failed to enrich this ip.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SecurityInsights/enrichment/domain/whois/": { + "get": { + "x-ms-examples": { + "Get whois information for a single domain name": { + "$ref": "./examples/enrichment/GetWhoisByDomainName.json" + } + }, + "tags": [ + "Enrichment" + ], + "description": "Get whois information for a single domain name", + "operationId": "DomainWhois_Get", + "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/EnrichmentDomain" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EnrichmentDomainWhois" + } + }, + "default": { + "description": "Error response describing why the operation failed to enrich this domain.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "EnrichmentIpAddress": { + "description": "IP address (v4 or v6) to be enriched", + "in": "query", + "name": "ipAddress", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EnrichmentDomain": { + "description": "Domain name to be enriched", + "in": "query", + "name": "domain", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "EnrichmentDomainWhois": { + "description": "Whois information for a given domain and associated metadata", + "properties": { + "domain": { + "description": "The domain for this whois record", + "type": "string" + }, + "server": { + "description": "The hostname of this registrar's whois server", + "type": "string" + }, + "created": { + "description": "The timestamp at which this record was created", + "format": "date-time", + "type": "string" + }, + "updated": { + "description": "The timestamp at which this record was last updated", + "format": "date-time", + "type": "string" + }, + "expires": { + "description": "The timestamp at which this record will expire", + "format": "date-time", + "type": "string" + }, + "parsedWhois": { + "description": "The whois record for a given domain", + "$ref": "#/definitions/EnrichmentDomainWhoisDetails" + } + }, + "type": "object" + }, + "EnrichmentDomainWhoisDetails": { + "description": "The whois record for a given domain", + "properties": { + "registrar": { + "description": "The registrar associated with this domain", + "$ref": "#/definitions/EnrichmentDomainWhoisRegistrarDetails" + }, + "contacts": { + "description": "The set of contacts associated with this domain", + "$ref": "#/definitions/EnrichmentDomainWhoisContacts" + }, + "nameServers": { + "description": "A list of name servers associated with this domain", + "type": "array", + "items": { + "type": "string" + } + }, + "statuses": { + "description": "The set of status flags for this whois record", + "type": "array", + "items": { + "type": "string" + } + } + }, + "type": "object" + }, + "EnrichmentDomainWhoisRegistrarDetails": { + "description": "The registrar associated with this domain", + "properties": { + "name": { + "description": "The name of this registrar", + "type": "string" + }, + "abuseContactEmail": { + "description": "This registrar's abuse contact email", + "type": "string" + }, + "abuseContactPhone": { + "description": "This registrar's abuse contact phone number", + "type": "string" + }, + "ianaId": { + "description": "This registrar's Internet Assigned Numbers Authority id", + "type": "string" + }, + "url": { + "description": "This registrar's URL", + "type": "string" + }, + "whoisServer": { + "description": "The hostname of this registrar's whois server", + "type": "string" + } + }, + "type": "object" + }, + "EnrichmentDomainWhoisContacts": { + "description": "The set of contacts associated with this domain", + "properties": { + "admin": { + "description": "The admin contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + }, + "billing": { + "description": "The billing contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + }, + "registrant": { + "description": "The registrant contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + }, + "tech": { + "description": "The technical contact for this whois record", + "$ref": "#/definitions/EnrichmentDomainWhoisContact" + } + }, + "type": "object" + }, + "EnrichmentDomainWhoisContact": { + "description": "An individual contact associated with this domain", + "properties": { + "name": { + "description": "The name of this contact", + "type": "string" + }, + "org": { + "description": "The organization for this contact", + "type": "string" + }, + "street": { + "description": "A list describing the street address for this contact", + "type": "array", + "items": { + "type": "string" + } + }, + "city": { + "description": "The city for this contact", + "type": "string" + }, + "state": { + "description": "The state for this contact", + "type": "string" + }, + "postal": { + "description": "The postal code for this contact", + "type": "string" + }, + "country": { + "description": "The country for this contact", + "type": "string" + }, + "phone": { + "description": "The phone number for this contact", + "type": "string" + }, + "fax": { + "description": "The fax number for this contact", + "type": "string" + }, + "email": { + "description": "The email address for this contact", + "type": "string" + } + }, + "type": "object" + }, + "EnrichmentIpGeodata": { + "description": "Geodata information for a given IP address", + "properties": { + "asn": { + "description": "The autonomous system number associated with this IP address", + "type": "string" + }, + "carrier": { + "description": "The name of the carrier for this IP address", + "type": "string" + }, + "city": { + "description": "The city this IP address is located in", + "type": "string" + }, + "cityCf": { + "description": "A numeric rating of confidence that the value in the 'city' field is correct, on a scale of 0-100", + "type": "integer", + "format": "int32" + }, + "continent": { + "description": "The continent this IP address is located on", + "type": "string" + }, + "country": { + "description": "The county this IP address is located in", + "type": "string" + }, + "countryCf": { + "description": "A numeric rating of confidence that the value in the 'country' field is correct on a scale of 0-100", + "type": "integer", + "format": "int32" + }, + "ipAddr": { + "description": "The dotted-decimal or colon-separated string representation of the IP address", + "type": "string" + }, + "ipRoutingType": { + "description": "A description of the connection type of this IP address", + "type": "string" + }, + "latitude": { + "description": "The latitude of this IP address", + "type": "string" + }, + "longitude": { + "description": "The longitude of this IP address", + "type": "string" + }, + "organization": { + "description": "The name of the organization for this IP address", + "type": "string" + }, + "organizationType": { + "description": "The type of the organization for this IP address", + "type": "string" + }, + "region": { + "description": "The geographic region this IP address is located in", + "type": "string" + }, + "state": { + "description": "The state this IP address is located in", + "type": "string" + }, + "stateCf": { + "description": "A numeric rating of confidence that the value in the 'state' field is correct on a scale of 0-100", + "type": "integer", + "format": "int32" + }, + "stateCode": { + "description": "The abbreviated name for the state this IP address is located in", + "type": "string" + } + }, + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Entities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Entities.json new file mode 100644 index 000000000000..4db8d66c362d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Entities.json @@ -0,0 +1,1556 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities": { + "get": { + "x-ms-examples": { + "Get all entities.": { + "$ref": "./examples/entities/GetEntities.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Gets all entities.", + "operationId": "Entities_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}": { + "get": { + "x-ms-examples": { + "Get an account entity.": { + "$ref": "./examples/entities/GetAccountEntityById.json" + }, + "Get a host entity.": { + "$ref": "./examples/entities/GetHostEntityById.json" + }, + "Get a file entity.": { + "$ref": "./examples/entities/GetFileEntityById.json" + }, + "Get a security alert entity.": { + "$ref": "./examples/entities/GetSecurityAlertEntityById.json" + }, + "Get a file hash entity.": { + "$ref": "./examples/entities/GetFileHashEntityById.json" + }, + "Get a malware entity.": { + "$ref": "./examples/entities/GetMalwareEntityById.json" + }, + "Get a security group entity.": { + "$ref": "./examples/entities/GetSecurityGroupEntityById.json" + }, + "Get an azure resource entity.": { + "$ref": "./examples/entities/GetAzureResourceEntityById.json" + }, + "Get a cloud application entity.": { + "$ref": "./examples/entities/GetCloudApplicationEntityById.json" + }, + "Get a process entity.": { + "$ref": "./examples/entities/GetProcessEntityById.json" + }, + "Get a dns entity.": { + "$ref": "./examples/entities/GetDnsEntityById.json" + }, + "Get an ip entity.": { + "$ref": "./examples/entities/GetIpEntityById.json" + }, + "Get a registry key entity.": { + "$ref": "./examples/entities/GetRegistryKeyEntityById.json" + }, + "Get a registry value entity.": { + "$ref": "./examples/entities/GetRegistryValueEntityById.json" + }, + "Get a url entity.": { + "$ref": "./examples/entities/GetUrlEntityById.json" + }, + "Get an IoT device entity.": { + "$ref": "./examples/entities/GetIoTDeviceEntityById.json" + }, + "Get a mailCluster entity.": { + "$ref": "./examples/entities/GetMailClusterEntityById.json" + }, + "Get a mailbox entity.": { + "$ref": "./examples/entities/GetMailboxEntityById.json" + }, + "Get a mailMessage entity.": { + "$ref": "./examples/entities/GetMailMessageEntityById.json" + }, + "Get a submissionMail entity.": { + "$ref": "./examples/entities/GetSubmissionMailEntityById.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Gets an entity.", + "operationId": "Entities_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/EntityTypes.json#/definitions/Entity" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/expand": { + "post": { + "x-ms-examples": { + "Expand an entity": { + "$ref": "./examples/entities/expand/PostExpandEntity.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Expands an entity.", + "operationId": "Entities_Expand", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/EntityExpandRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityExpandResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/getTimeline": { + "post": { + "x-ms-examples": { + "Entity timeline": { + "$ref": "./examples/entities/timeline/PostTimelineEntity.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Timeline for an entity.", + "operationId": "EntitiesGetTimeline_list", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/EntityTimelineRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityTimelineResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/queries": { + "get": { + "x-ms-examples": { + "Get Entity Query": { + "$ref": "./examples/entities/GetQueries.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Get Insights and Activities for an entity.", + "operationId": "Entities_Queries", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/EntityQueryKindParam" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GetQueriesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/getInsights": { + "post": { + "x-ms-examples": { + "Entity Insight": { + "$ref": "./examples/entities/insights/PostGetInsights.json" + } + }, + "tags": [ + "Entities" + ], + "description": "Execute Insights for an entity.", + "operationId": "Entities_GetInsights", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "#/parameters/GetInsightsEntityQueriesRequestBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityGetInsightsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/relations": { + "get": { + "x-ms-examples": { + "Get all relations of an entity.": { + "$ref": "./examples/entities/relations/GetAllEntityRelations.json" + } + }, + "tags": [ + "EntityRelations" + ], + "description": "Gets all relations of an entity.", + "operationId": "EntitiesRelations_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/RelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "./common/RelationTypes.json#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entities/{entityId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get an entity relation.": { + "$ref": "./examples/entities/relations/GetEntityRelationByName.json" + } + }, + "tags": [ + "EntityRelations" + ], + "description": "Gets an entity relation.", + "operationId": "EntityRelations_GetRelation", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "EntityExpandRequestBody": { + "description": "The parameters required to execute an expand operation on the given entity.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/EntityExpandParameters" + }, + "x-ms-parameter-location": "method" + }, + "EntityId": { + "description": "entity ID", + "in": "path", + "name": "entityId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityTimelineRequestBody": { + "description": "The parameters required to execute an timeline operation on the given entity.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/EntityTimelineParameters" + }, + "x-ms-parameter-location": "method" + }, + "EntityQueryKindParam": { + "description": "The Kind parameter for queries", + "in": "query", + "name": "kind", + "required": true, + "type": "string", + "enum": [ + "Insight" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "EntityItemQueryKind", + "values": [ + { + "description": "insight", + "value": "Insight" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "GetInsightsEntityQueriesRequestBody": { + "description": "The parameters required to execute insights on the given entity.", + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EntityGetInsightsParameters" + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ActivityTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents Activity timeline item.", + "properties": { + "queryId": { + "type": "string", + "description": "The activity query id." + }, + "bucketStartTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The grouping bucket start time." + }, + "bucketEndTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The grouping bucket end time." + }, + "firstActivityTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The time of the first activity in the grouping bucket." + }, + "lastActivityTimeUTC": { + "format": "date-time", + "type": "string", + "description": "The time of the last activity in the grouping bucket." + }, + "content": { + "type": "string", + "description": "The activity timeline content." + }, + "title": { + "type": "string", + "description": "The activity timeline title." + } + }, + "required": [ + "queryId", + "bucketStartTimeUTC", + "bucketEndTimeUTC", + "firstActivityTimeUTC", + "lastActivityTimeUTC", + "content", + "title" + ], + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "BookmarkTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents bookmark timeline item.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The bookmark azure resource id." + }, + "displayName": { + "type": "string", + "description": "The bookmark display name." + }, + "notes": { + "type": "string", + "description": "The notes of the bookmark" + }, + "endTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The bookmark end time." + }, + "startTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The bookmark start time." + }, + "eventTime": { + "format": "date-time", + "type": "string", + "description": "The bookmark event time." + }, + "createdBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that created the bookmark" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array" + } + }, + "required": [ + "azureResourceId" + ], + "type": "object", + "x-ms-discriminator-value": "Bookmark" + }, + "AnomalyTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents anomaly timeline item.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The anomaly azure resource id." + }, + "productName": { + "type": "string", + "description": "The anomaly product name." + }, + "description": { + "type": "string", + "description": "The anomaly description." + }, + "displayName": { + "type": "string", + "description": "The anomaly name." + }, + "endTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The anomaly end time." + }, + "startTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The anomaly start time." + }, + "timeGenerated": { + "format": "date-time", + "type": "string", + "description": "The anomaly generated time." + }, + "vendor": { + "type": "string", + "description": "The name of the anomaly vendor." + }, + "intent": { + "type": "string", + "description": "The intent of the anomaly." + }, + "techniques": { + "type": "array", + "items": { + "type": "string", + "description": "technique of the anomaly" + }, + "description": "The techniques of the anomaly." + }, + "reasons": { + "type": "array", + "items": { + "type": "string", + "description": "Reason of the anomaly" + }, + "description": "The reasons that cause the anomaly." + } + }, + "required": [ + "azureResourceId", + "displayName", + "endTimeUtc", + "startTimeUtc", + "timeGenerated" + ], + "type": "object", + "x-ms-discriminator-value": "Anomaly" + }, + "EntityGetInsightsParameters": { + "description": "The parameters required to execute insights operation on the given entity.", + "type": "object", + "properties": { + "startTime": { + "description": "The start timeline date, so the results returned are after this date.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "The end timeline date, so the results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "addDefaultExtendedTimeRange": { + "description": "Indicates if query time range should be extended with default time range of the query. Default value is false", + "type": "boolean" + }, + "insightQueryIds": { + "description": "List of Insights Query Id. If empty, default value is all insights of this entity", + "type": "array", + "items": { + "description": "Insight Query Id (GUID)", + "format": "uuid", + "type": "string" + } + } + }, + "required": [ + "startTime", + "endTime" + ] + }, + "EntityGetInsightsResponse": { + "description": "The Get Insights result operation response.", + "properties": { + "metaData": { + "$ref": "#/definitions/GetInsightsResultsMetadata", + "description": "The metadata from the get insights operation results." + }, + "value": { + "description": "The insights result values.", + "items": { + "$ref": "#/definitions/EntityInsightItem" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "EntityEdges": { + "description": "The edge that connects the entity to the other entity.", + "properties": { + "targetEntityId": { + "description": "The target entity Id.", + "type": "string" + }, + "additionalData": { + "additionalProperties": true, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "type": "object" + } + }, + "type": "object" + }, + "EntityExpandParameters": { + "description": "The parameters required to execute an expand operation on the given entity.", + "properties": { + "endTime": { + "description": "The end date filter, so the only expansion results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "expansionId": { + "description": "The Id of the expansion to perform.", + "format": "uuid", + "type": "string" + }, + "startTime": { + "description": "The start date filter, so the only expansion results returned are after this date.", + "format": "date-time", + "type": "string" + } + }, + "type": "object" + }, + "EntityExpandResponse": { + "description": "The entity expansion result operation response.", + "properties": { + "metaData": { + "$ref": "./common/EntityTypes.json#/definitions/ExpansionResultsMetadata", + "description": "The metadata from the expansion operation results." + }, + "value": { + "description": "The expansion result values.", + "properties": { + "entities": { + "description": "Array of the expansion result entities.", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/Entity" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "edges": { + "description": "Array of edges that connects the entity to the list of entities.", + "items": { + "$ref": "#/definitions/EntityEdges" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + } + }, + "type": "object" + }, + "EntityInsightItem": { + "description": "Entity insight Item.", + "type": "object", + "properties": { + "queryId": { + "type": "string", + "description": "The query id of the insight" + }, + "queryTimeInterval": { + "type": "object", + "description": "The Time interval that the query actually executed on.", + "properties": { + "startTime": { + "format": "date-time", + "type": "string", + "description": "Insight query start time" + }, + "endTime": { + "format": "date-time", + "type": "string", + "description": "Insight query end time" + } + } + }, + "tableQueryResults": { + "$ref": "#/definitions/InsightsTableResult", + "description": "Query results for table insights query." + }, + "chartQueryResults": { + "type": "array", + "description": "Query results for table insights query.", + "items": { + "$ref": "#/definitions/InsightsTableResult", + "description": "Query results for table insights query." + }, + "x-ms-identifiers": [] + } + } + }, + "EntityList": { + "description": "List of all the entities.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of entities.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of entities.", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/Entity" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "EntityTimelineItem": { + "description": "Entity timeline Item.", + "discriminator": "kind", + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/EntityTimelineKind", + "description": "The entity query kind type." + } + }, + "required": [ + "kind" + ] + }, + "EntityTimelineResponse": { + "description": "The entity timeline result operation response.", + "properties": { + "metaData": { + "$ref": "#/definitions/TimelineResultsMetadata", + "description": "The metadata from the timeline operation results." + }, + "value": { + "description": "The timeline result values.", + "items": { + "$ref": "#/definitions/EntityTimelineItem" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "EntityTimelineKind": { + "description": "The entity query kind", + "enum": [ + "Activity", + "Bookmark", + "SecurityAlert", + "Anomaly" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityTimelineKind", + "values": [ + { + "description": "activity", + "value": "Activity" + }, + { + "description": "bookmarks", + "value": "Bookmark" + }, + { + "description": "security alerts", + "value": "SecurityAlert" + }, + { + "description": "anomaly", + "value": "Anomaly" + } + ] + } + }, + "EntityTimelineParameters": { + "description": "The parameters required to execute s timeline operation on the given entity.", + "properties": { + "kinds": { + "description": "Array of timeline Item kinds.", + "items": { + "$ref": "#/definitions/EntityTimelineKind" + }, + "type": "array" + }, + "startTime": { + "description": "The start timeline date, so the results returned are after this date.", + "format": "date-time", + "type": "string" + }, + "endTime": { + "description": "The end timeline date, so the results returned are before this date.", + "format": "date-time", + "type": "string" + }, + "numberOfBucket": { + "description": "The number of bucket for timeline queries aggregation.", + "type": "integer", + "format": "int32" + } + }, + "type": "object", + "required": [ + "startTime", + "endTime" + ] + }, + "EntityQueryItem": { + "description": "An abstract Query item for entity", + "type": "object", + "discriminator": "kind", + "properties": { + "id": { + "description": "Query Template ARM ID", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Query Template ARM Name", + "type": "string" + }, + "type": { + "description": "ARM Type", + "type": "string" + }, + "kind": { + "$ref": "./common/EntityTypes.json#/definitions/EntityQueryKind", + "description": "The kind of the entity query" + } + }, + "required": [ + "kind" + ] + }, + "EntityQueryItemProperties": { + "description": "An properties abstract Query item for entity", + "type": "object", + "properties": { + "dataTypes": { + "description": "Data types for template", + "type": "array", + "items": { + "properties": { + "dataType": { + "description": "Data type name", + "type": "string" + } + }, + "type": "object" + }, + "x-ms-identifiers": [] + }, + "inputEntityType": { + "description": "The type of the entity", + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerType" + }, + "requiredInputFieldsSets": { + "description": "Data types for template", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "entitiesFilter": { + "description": "The query applied only to entities matching to all filters", + "type": "object" + } + } + }, + "InsightsTableResult": { + "type": "object", + "description": "Query results for table insights query.", + "properties": { + "columns": { + "type": "array", + "description": "Columns Metadata of the table", + "items": { + "properties": { + "type": { + "type": "string", + "description": "the type of the colum" + }, + "name": { + "type": "string", + "description": "the name of the colum" + } + }, + "type": "object" + }, + "x-ms-identifiers": [] + }, + "rows": { + "type": "array", + "description": "Rows data of the table", + "items": { + "type": "array", + "description": "Single row of data", + "items": { + "type": "string", + "description": "Cell in the table" + } + } + } + } + }, + "InsightQueryItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityQueryItem" + } + ], + "description": "Represents Insight Query.", + "properties": { + "properties": { + "description": "Properties bag for InsightQueryItem", + "$ref": "#/definitions/InsightQueryItemProperties" + } + }, + "type": "object", + "x-ms-discriminator-value": "Insight" + }, + "InsightQueryItemProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityQueryItemProperties" + } + ], + "description": "Represents Insight Query.", + "properties": { + "displayName": { + "type": "string", + "description": "The insight display name." + }, + "description": { + "type": "string", + "description": "The insight description." + }, + "baseQuery": { + "type": "string", + "description": "The base query of the insight." + }, + "tableQuery": { + "type": "object", + "description": "The insight table query.", + "properties": { + "columnsDefinitions": { + "type": "array", + "description": "List of insight column definitions.", + "items": { + "properties": { + "header": { + "type": "string", + "description": "Insight column header." + }, + "outputType": { + "type": "string", + "description": "Insights Column type.", + "enum": [ + "Number", + "String", + "Date", + "Entity" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "outputType" + } + }, + "supportDeepLink": { + "type": "boolean", + "description": "Is query supports deep-link." + } + }, + "type": "object" + }, + "x-ms-identifiers": [] + }, + "queriesDefinitions": { + "type": "array", + "description": "List of insight queries definitions.", + "x-ms-identifiers": [], + "items": { + "properties": { + "filter": { + "type": "string", + "description": "Insight column header." + }, + "summarize": { + "type": "string", + "description": "Insight column header." + }, + "project": { + "type": "string", + "description": "Insight column header." + }, + "linkColumnsDefinitions": { + "type": "array", + "description": "Insight column header.", + "x-ms-identifiers": [], + "items": { + "properties": { + "projectedName": { + "type": "string", + "description": "Insight Link Definition Projected Name." + }, + "Query": { + "type": "string", + "description": "Insight Link Definition Query." + } + }, + "type": "object" + } + } + }, + "type": "object" + } + } + } + }, + "chartQuery": { + "type": "object", + "description": "The insight chart query." + }, + "additionalQuery": { + "type": "object", + "description": "The activity query definitions.", + "properties": { + "query": { + "type": "string", + "description": "The insight query." + }, + "text": { + "type": "string", + "description": "The insight text." + } + } + }, + "defaultTimeRange": { + "type": "object", + "description": "The insight chart query.", + "properties": { + "beforeRange": { + "type": "string", + "description": "The padding for the start time of the query." + }, + "afterRange": { + "type": "string", + "description": "The padding for the end time of the query." + } + } + }, + "referenceTimeRange": { + "type": "object", + "description": "The insight chart query.", + "properties": { + "beforeRange": { + "type": "string", + "description": "Additional query time for looking back." + } + } + } + }, + "type": "object" + }, + "GetInsightsResultsMetadata": { + "description": "Get Insights result metadata.", + "properties": { + "totalCount": { + "description": "the total items found for the insights request", + "type": "integer", + "format": "int32" + }, + "errors": { + "description": "information about the failed queries", + "items": { + "$ref": "#/definitions/GetInsightsErrorKind" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "required": [ + "totalCount" + ], + "type": "object" + }, + "GetInsightsErrorKind": { + "description": "GetInsights Query Errors.", + "properties": { + "kind": { + "description": "the query kind", + "type": "string", + "enum": [ + "Insight" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "GetInsightsError", + "values": [ + { + "value": "Insight" + } + ] + } + }, + "queryId": { + "description": "the query id", + "type": "string" + }, + "errorMessage": { + "description": "the error message", + "type": "string" + } + }, + "required": [ + "kind", + "errorMessage" + ], + "type": "object" + }, + "GetQueriesResponse": { + "description": "Retrieve queries for entity result operation response.", + "properties": { + "value": { + "description": "The query result values.", + "items": { + "$ref": "#/definitions/EntityQueryItem" + }, + "type": "array" + } + }, + "type": "object" + }, + "SecurityAlertTimelineItem": { + "allOf": [ + { + "$ref": "#/definitions/EntityTimelineItem" + } + ], + "description": "Represents security alert timeline item.", + "properties": { + "azureResourceId": { + "type": "string", + "description": "The alert azure resource id." + }, + "productName": { + "type": "string", + "description": "The alert product name." + }, + "description": { + "type": "string", + "description": "The alert description." + }, + "displayName": { + "type": "string", + "description": "The alert name." + }, + "severity": { + "$ref": "./common/AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The alert severity." + }, + "endTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The alert end time." + }, + "startTimeUtc": { + "format": "date-time", + "type": "string", + "description": "The alert start time." + }, + "timeGenerated": { + "format": "date-time", + "type": "string", + "description": "The alert generated time." + }, + "alertType": { + "type": "string", + "description": "The name of the alert type." + }, + "intent": { + "type": "string", + "description": "The intent of the alert.", + "enum": [ + "Unknown", + "Probing", + "Exploitation", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Execution", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" + ], + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "KillChainIntent", + "values": [ + { + "description": "The default value.", + "value": "Unknown" + }, + { + "description": "Probing could be an attempt to access a certain resource regardless of a malicious intent or a failed attempt to gain access to a target system to gather information prior to exploitation. This step is usually detected as an attempt originating from outside the network in attempt to scan the target system and find a way in.", + "value": "Probing" + }, + { + "description": "Exploitation is the stage where an attacker manage to get foothold on the attacked resource. This stage is applicable not only for compute hosts, but also for resources such as user accounts, certificates etc. Adversaries will often be able to control the resource after this stage.", + "value": "Exploitation" + }, + { + "description": "Persistence is any access, action, or configuration change to a system that gives an adversary a persistent presence on that system. Adversaries will often need to maintain access to systems through interruptions such as system restarts, loss of credentials, or other failures that would require a remote access tool to restart or alternate backdoor for them to regain access.", + "value": "Persistence" + }, + { + "description": "Privilege escalation is the result of actions that allow an adversary to obtain a higher level of permissions on a system or network. Certain tools or actions require a higher level of privilege to work and are likely necessary at many points throughout an operation. User accounts with permissions to access specific systems or perform specific functions necessary for adversaries to achieve their objective may also be considered an escalation of privilege.", + "value": "PrivilegeEscalation" + }, + { + "description": "Defense evasion consists of techniques an adversary may use to evade detection or avoid other defenses. Sometimes these actions are the same as or variations of techniques in other categories that have the added benefit of subverting a particular defense or mitigation. ", + "value": "DefenseEvasion" + }, + { + "description": "Credential access represents techniques resulting in access to or control over system, domain, or service credentials that are used within an enterprise environment. Adversaries will likely attempt to obtain legitimate credentials from users or administrator accounts (local system administrator or domain users with administrator access) to use within the network. With sufficient access within a network, an adversary can create accounts for later use within the environment.", + "value": "CredentialAccess" + }, + { + "description": "Discovery consists of techniques that allow the adversary to gain knowledge about the system and internal network. When adversaries gain access to a new system, they must navigate themselves to what they now have control of and what benefits operating from that system give to their current objective or overall goals during the intrusion. The operating system provides many native tools that aid in this post-compromise information-gathering phase.", + "value": "Discovery" + }, + { + "description": "Lateral movement consists of techniques that enable an adversary to access and control remote systems on a network and could, but does not necessarily, include execution of tools on remote systems. The lateral movement techniques could allow an adversary to gather information from a system without needing additional tools, such as a remote access tool. An adversary can use lateral movement for many purposes, including remote Execution of tools, pivoting to additional systems, access to specific information or files, access to additional credentials, or to cause an effect.", + "value": "LateralMovement" + }, + { + "description": "The execution tactic represents techniques that result in execution of adversary-controlled code on a local or remote system. This tactic is often used in conjunction with lateral movement to expand access to remote systems on a network.", + "value": "Execution" + }, + { + "description": "Collection consists of techniques used to identify and gather information, such as sensitive files, from a target network prior to exfiltration. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Collection" + }, + { + "description": "Exfiltration refers to techniques and attributes that result or aid in the adversary removing files and information from a target network. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Exfiltration" + }, + { + "description": "The command and control tactic represents how adversaries communicate with systems under their control within a target network.", + "value": "CommandAndControl" + }, + { + "description": "The impact intent primary objective is to directly reduce the availability or integrity of a system, service, or network; including manipulation of data to impact a business or operational process. This would often refer to techniques such as ransom-ware, defacement, data manipulation and others.", + "value": "Impact" + } + ] + } + }, + "techniques": { + "type": "array", + "items": { + "type": "string", + "description": "technique of the alert" + }, + "description": "The techniques of the alert." + } + }, + "required": [ + "azureResourceId", + "displayName", + "severity", + "endTimeUtc", + "startTimeUtc", + "timeGenerated", + "alertType" + ], + "type": "object", + "x-ms-discriminator-value": "SecurityAlert" + }, + "TimelineError": { + "description": "Timeline Query Errors.", + "properties": { + "kind": { + "description": "the query kind", + "$ref": "#/definitions/EntityTimelineKind" + }, + "queryId": { + "description": "the query id", + "type": "string" + }, + "errorMessage": { + "description": "the error message", + "type": "string" + } + }, + "required": [ + "kind", + "errorMessage" + ], + "type": "object" + }, + "TimelineResultsMetadata": { + "description": "Expansion result metadata.", + "properties": { + "totalCount": { + "description": "the total items found for the timeline request", + "type": "integer", + "format": "int32" + }, + "aggregations": { + "description": "timeline aggregation per kind", + "items": { + "$ref": "#/definitions/TimelineAggregation" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "errors": { + "description": "information about the failure queries", + "items": { + "$ref": "#/definitions/TimelineError" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "required": [ + "totalCount", + "aggregations" + ], + "type": "object" + }, + "TimelineAggregation": { + "description": "timeline aggregation information per kind", + "properties": { + "count": { + "description": "the total items found for a kind", + "type": "integer", + "format": "int32" + }, + "kind": { + "description": "the query kind", + "$ref": "#/definitions/EntityTimelineKind" + } + }, + "required": [ + "kind", + "count" + ], + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/EntityQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/EntityQueries.json new file mode 100644 index 000000000000..c86fd47c8a37 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/EntityQueries.json @@ -0,0 +1,507 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueries": { + "get": { + "x-ms-examples": { + "Get all entity queries.": { + "$ref": "./examples/entityQueries/GetEntityQueries.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Gets all entity queries.", + "operationId": "EntityQueries_List", + "parameters": [ + { + "$ref": "#/parameters/EntityQueryKind" + }, + { + "$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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQueryList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueries/{entityQueryId}": { + "get": { + "x-ms-examples": { + "Get an Expansion entity query.": { + "$ref": "./examples/entityQueries/GetExpansionEntityQueryById.json" + }, + "Get an Activity entity query.": { + "$ref": "./examples/entityQueries/GetActivityEntityQueryById.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Gets an entity query.", + "operationId": "EntityQueries_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQuery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an Activity entity query.": { + "$ref": "./examples/entityQueries/CreateEntityQueryActivity.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Creates or updates the entity query.", + "operationId": "EntityQueries_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryId" + }, + { + "$ref": "#/parameters/CustomEntityQuery" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQuery" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/EntityQuery" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an entity query.": { + "$ref": "./examples/entityQueries/DeleteEntityQuery.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Delete the entity query.", + "operationId": "EntityQueries_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "CustomEntityQueryKind": { + "description": "The kind of the entity query that supports put request.", + "enum": [ + "Activity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "CustomEntityQueryKind", + "values": [ + { + "value": "Activity" + } + ] + } + }, + "EntityQueryList": { + "description": "List of all the entity queries.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of entity queries.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of entity queries.", + "items": { + "$ref": "#/definitions/EntityQuery" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "EntityQuery": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Specific entity query.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "./common/EntityTypes.json#/definitions/EntityQueryKind", + "description": "the entity query kind" + } + }, + "type": "object", + "required": [ + "kind" + ] + }, + "CustomEntityQuery": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Specific entity query that supports put requests.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/CustomEntityQueryKind", + "description": "the entity query kind" + } + }, + "type": "object", + "required": [ + "kind" + ] + }, + "ExpansionEntityQuery": { + "description": "Represents Expansion entity query.", + "allOf": [ + { + "$ref": "#/definitions/EntityQuery" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ExpansionEntityQueriesProperties", + "description": "Expansion entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Expansion" + }, + "ExpansionEntityQueriesProperties": { + "description": "Describes expansion entity query properties", + "properties": { + "dataSources": { + "description": "List of the data sources that are required to run the query", + "items": { + "description": "data source", + "type": "string" + }, + "type": "array" + }, + "displayName": { + "description": "The query display name", + "type": "string" + }, + "inputEntityType": { + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerType", + "description": "The type of the query's source entity" + }, + "inputFields": { + "description": "List of the fields of the source entity that are required to run the query", + "items": { + "description": "input field", + "type": "string" + }, + "type": "array" + }, + "outputEntityTypes": { + "description": "List of the desired output types to be constructed from the result", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerType", + "description": "output entity type" + }, + "type": "array" + }, + "queryTemplate": { + "description": "The template query string to be parsed and formatted", + "type": "string" + } + }, + "type": "object" + }, + "ActivityEntityQuery": { + "description": "Represents Activity entity query.", + "allOf": [ + { + "$ref": "#/definitions/EntityQuery" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActivityEntityQueriesProperties", + "description": "Activity entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "ActivityCustomEntityQuery": { + "description": "Represents Activity entity query.", + "allOf": [ + { + "$ref": "#/definitions/CustomEntityQuery" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActivityEntityQueriesProperties", + "description": "Activity entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "ActivityEntityQueriesProperties": { + "description": "Describes activity entity query properties", + "properties": { + "title": { + "description": "The entity query title", + "type": "string" + }, + "content": { + "description": "The entity query content to display in timeline", + "type": "string" + }, + "description": { + "description": "The entity query description", + "type": "string" + }, + "queryDefinitions": { + "description": "The Activity query definitions", + "properties": { + "query": { + "description": "The Activity query to run on a given entity", + "type": "string" + } + }, + "type": "object" + }, + "inputEntityType": { + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerType", + "description": "The type of the query's source entity" + }, + "requiredInputFieldsSets": { + "description": "List of the fields of the source entity that are required to run the query", + "items": { + "description": "Sub sets of the field of the source entity that are required to run the query", + "items": { + "description": "Required input field name", + "type": "string" + }, + "type": "array" + }, + "type": "array" + }, + "entitiesFilter": { + "description": "The query applied only to entities matching to all filters", + "type": "object", + "additionalProperties": { + "description": "Filter field name", + "items": { + "description": "Filter field values", + "type": "string" + }, + "type": "array" + } + }, + "templateName": { + "description": "The template id this activity was created from", + "type": "string" + }, + "enabled": { + "description": "Determines whether this activity is enabled or disabled.", + "type": "boolean" + }, + "createdTimeUtc": { + "description": "The time the activity was created", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "lastModifiedTimeUtc": { + "description": "The last time the activity was updated", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": { + "EntityQueryId": { + "description": "entity query ID", + "in": "path", + "name": "entityQueryId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityQueryKind": { + "description": "The entity query kind we want to fetch", + "in": "query", + "name": "kind", + "required": false, + "enum": [ + "Expansion", + "Activity" + ], + "type": "string", + "x-ms-parameter-location": "method" + }, + "CustomEntityQuery": { + "description": "The entity query we want to create or update", + "in": "body", + "name": "entityQuery", + "required": true, + "schema": { + "$ref": "#/definitions/CustomEntityQuery" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/EntityQueryTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/EntityQueryTemplates.json new file mode 100644 index 000000000000..68d545bf9961 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/EntityQueryTemplates.json @@ -0,0 +1,304 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueryTemplates": { + "get": { + "x-ms-examples": { + "Get all entity query templates.": { + "$ref": "./examples/entityQueryTemplates/GetEntityQueryTemplates.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Gets all entity query templates.", + "operationId": "EntityQueryTemplates_List", + "parameters": [ + { + "$ref": "#/parameters/EntityQueryTemplateKind" + }, + { + "$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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQueryTemplateList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/entityQueryTemplates/{entityQueryTemplateId}": { + "get": { + "x-ms-examples": { + "Get an Activity entity query template.": { + "$ref": "./examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json" + } + }, + "tags": [ + "EntityQueries" + ], + "description": "Gets an entity query.", + "operationId": "EntityQueryTemplates_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/EntityQueryTemplateId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityQueryTemplate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "EntityQueryTemplateKind": { + "description": "The kind of the entity query template.", + "enum": [ + "Activity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityQueryTemplateKind", + "values": [ + { + "value": "Activity" + } + ] + } + }, + "EntityQueryTemplateList": { + "description": "List of all the entity query templates.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of entity query templates.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of entity query templates.", + "items": { + "$ref": "#/definitions/EntityQueryTemplate" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "EntityQueryTemplate": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "Specific entity query template.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/EntityQueryTemplateKind", + "description": "the entity query template kind" + } + }, + "type": "object", + "required": [ + "kind" + ] + }, + "ActivityEntityQueryTemplate": { + "description": "Represents Activity entity query.", + "allOf": [ + { + "$ref": "#/definitions/EntityQueryTemplate" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ActivityEntityQueryTemplateProperties", + "description": "Activity entity query properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Activity" + }, + "ActivityEntityQueryTemplateProperties": { + "description": "Describes activity entity query properties", + "properties": { + "title": { + "description": "The entity query title", + "type": "string" + }, + "content": { + "description": "The entity query content to display in timeline", + "type": "string" + }, + "description": { + "description": "The entity query description", + "type": "string" + }, + "queryDefinitions": { + "description": "The Activity query definitions", + "properties": { + "query": { + "description": "The Activity query to run on a given entity", + "type": "string" + }, + "summarizeBy": { + "description": "The dimensions we want to summarize the timeline results on, this is comma separated list", + "type": "string" + } + }, + "type": "object" + }, + "dataTypes": { + "description": "List of required data types for the given entity query template", + "items": { + "$ref": "#/definitions/DataTypeDefinitions" + }, + "type": "array" + }, + "inputEntityType": { + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerType", + "description": "The type of the query's source entity" + }, + "requiredInputFieldsSets": { + "description": "List of the fields of the source entity that are required to run the query", + "items": { + "description": "Sub sets of the field of the source entity that are required to run the query", + "items": { + "description": "Required input field name", + "type": "string" + }, + "type": "array" + }, + "type": "array" + }, + "entitiesFilter": { + "description": "The query applied only to entities matching to all filters", + "type": "object", + "additionalProperties": { + "description": "Filter field name", + "items": { + "description": "Filter field values", + "type": "string" + }, + "type": "array" + } + } + }, + "type": "object" + }, + "DataTypeDefinitions": { + "description": "The data type definition", + "properties": { + "dataType": { + "description": "The data type name", + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": { + "EntityQueryTemplateId": { + "description": "entity query template ID", + "in": "path", + "name": "entityQueryTemplateId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "EntityQueryTemplateKind": { + "description": "The entity template query kind we want to fetch", + "in": "query", + "name": "kind", + "required": false, + "enum": [ + "Activity" + ], + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/FileImports.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/FileImports.json new file mode 100644 index 000000000000..48d84fc9dfb8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/FileImports.json @@ -0,0 +1,564 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/fileImports": { + "get": { + "x-ms-examples": { + "Get all file imports.": { + "$ref": "./examples/fileImports/GetFileImports.json" + } + }, + "tags": [ + "FileImports" + ], + "description": "Gets all file imports.", + "operationId": "FileImports_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FileImportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/fileImports/{fileImportId}": { + "get": { + "x-ms-examples": { + "Get a file import.": { + "$ref": "./examples/fileImports/GetFileImportById.json" + } + }, + "tags": [ + "FileImports" + ], + "description": "Gets a file import.", + "operationId": "FileImports_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/FileImportId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/FileImport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create a file import.": { + "$ref": "./examples/fileImports/CreateFileImport.json" + } + }, + "tags": [ + "FileImports" + ], + "description": "Creates the file import.", + "operationId": "FileImports_Create", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/FileImportId" + }, + { + "$ref": "#/parameters/FileImport" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/FileImport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a file import.": { + "$ref": "./examples/fileImports/DeleteFileImport.json" + } + }, + "tags": [ + "FileImports" + ], + "description": "Delete the file import.", + "operationId": "FileImports_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/FileImportId" + } + ], + "responses": { + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/FileImport" + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "FileMetadata": { + "description": "Represents a file.", + "properties": { + "fileFormat": { + "description": "The format of the file", + "enum": [ + "CSV", + "JSON", + "Unspecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "fileFormat", + "values": [ + { + "description": "A CSV file.", + "value": "CSV" + }, + { + "description": "A JSON file.", + "value": "JSON" + }, + { + "description": "A file of other format.", + "value": "Unspecified" + } + ] + } + }, + "fileName": { + "description": "The name of the file.", + "type": "string" + }, + "fileSize": { + "description": "The size of the file.", + "format": "int32", + "type": "integer" + }, + "fileContentUri": { + "description": "A URI with a valid SAS token to allow uploading / downloading the file.", + "type": "string", + "readOnly": true + }, + "deleteStatus": { + "description": "Indicates whether the file was deleted from the storage account.", + "enum": [ + "Deleted", + "NotDeleted", + "Unspecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeleteStatus", + "values": [ + { + "description": "The file was deleted.", + "value": "Deleted" + }, + { + "description": "The file was not deleted.", + "value": "NotDeleted" + }, + { + "description": "Unspecified", + "value": "Unspecified" + } + ] + }, + "readOnly": true + } + }, + "type": "object" + }, + "FileImport": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "Represents a file import in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/FileImportProperties", + "description": "File import properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "FileImportList": { + "description": "List all the file imports.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of file imports.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of file imports.", + "items": { + "$ref": "#/definitions/FileImport" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "FileImportProperties": { + "description": "Describes the FileImport's properties", + "properties": { + "ingestionMode": { + "description": "Describes how to ingest the records in the file.", + "enum": [ + "IngestOnlyIfAllAreValid", + "IngestAnyValidRecords", + "Unspecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IngestionMode", + "values": [ + { + "description": "No records should be ingested when invalid records are detected.", + "value": "IngestOnlyIfAllAreValid" + }, + { + "description": "Valid records should still be ingested when invalid records are detected.", + "value": "IngestAnyValidRecords" + }, + { + "description": "Unspecified", + "value": "Unspecified" + } + ] + } + }, + "contentType": { + "description": "The content type of this file.", + "enum": [ + "BasicIndicator", + "StixIndicator", + "Unspecified" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "FileImportContentType", + "values": [ + { + "description": "File containing records with the core fields of an indicator, plus the observables to construct the STIX pattern.", + "value": "BasicIndicator" + }, + { + "description": "File containing STIX indicators.", + "value": "StixIndicator" + }, + { + "description": "File containing other records.", + "value": "Unspecified" + } + ] + } + }, + "createdTimeUTC": { + "description": "The time the file was imported.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errorFile": { + "description": "Represents the error file (if the import was ingested with errors or failed the validation).", + "$ref": "#/definitions/FileMetadata", + "readOnly": true, + "type": "object" + }, + "errorsPreview": { + "description": "An ordered list of some of the errors that were encountered during validation.", + "items": { + "description": "An error that were encountered during validation.", + "$ref": "#/definitions/ValidationError" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "importFile": { + "description": "Represents the imported file.", + "$ref": "#/definitions/FileMetadata", + "type": "object" + }, + "ingestedRecordCount": { + "description": "The number of records that have been successfully ingested.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "source": { + "description": "The source for the data in the file.", + "type": "string" + }, + "state": { + "description": "The state of the file import.", + "enum": [ + "FatalError", + "Ingested", + "IngestedWithErrors", + "InProgress", + "Invalid", + "WaitingForUpload", + "Unspecified" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "FileImportState", + "values": [ + { + "description": "A fatal error has occurred while ingesting the file.", + "value": "FatalError" + }, + { + "description": "The file has been ingested.", + "value": "Ingested" + }, + { + "description": "The file has been ingested with errors.", + "value": "IngestedWithErrors" + }, + { + "description": "The file ingestion is in progress.", + "value": "InProgress" + }, + { + "description": "The file is invalid.", + "value": "Invalid" + }, + { + "description": "Waiting for the file to be uploaded.", + "value": "WaitingForUpload" + }, + { + "description": "Unspecified state.", + "value": "Unspecified" + } + ] + } + }, + "totalRecordCount": { + "description": "The number of records in the file.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "validRecordCount": { + "description": "The number of records that have passed validation.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "filesValidUntilTimeUTC": { + "description": "The time the files associated with this import are deleted from the storage account.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "importValidUntilTimeUTC": { + "description": "The time the file import record is soft deleted from the database and history.", + "format": "date-time", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "ingestionMode", + "contentType", + "importFile", + "source" + ], + "type": "object" + }, + "ValidationError": { + "description": "Describes an error encountered in the file during validation.", + "properties": { + "recordIndex": { + "description": "The number of the record that has the error.", + "type": "integer", + "format": "int32" + }, + "errorMessages": { + "description": "A list of descriptions of the error.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + } + }, + "parameters": { + "FileImportId": { + "description": "File import ID", + "in": "path", + "name": "fileImportId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "FileImport": { + "description": "The file import", + "in": "body", + "name": "fileImport", + "required": true, + "schema": { + "$ref": "#/definitions/FileImport" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Hunts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Hunts.json new file mode 100644 index 000000000000..a35e610a0b62 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Hunts.json @@ -0,0 +1,992 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts": { + "get": { + "x-ms-examples": { + "Get all hunts.": { + "$ref": "./examples/hunts/GetHunts.json" + } + }, + "tags": [ + "Hunts" + ], + "description": "Gets all hunts, without relations and comments.", + "operationId": "Hunts_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HuntList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}": { + "get": { + "x-ms-examples": { + "Get a hunt.": { + "$ref": "./examples/hunts/GetHuntById.json" + } + }, + "tags": [ + "Hunts" + ], + "description": "Gets a hunt, without relations and comments.", + "operationId": "Hunts_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Hunt" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a hunt.": { + "$ref": "./examples/hunts/DeleteHunt.json" + } + }, + "tags": [ + "Hunts" + ], + "description": "Delete a hunt.", + "operationId": "Hunts_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a hunt.": { + "$ref": "./examples/hunts/CreateHunt.json" + } + }, + "tags": [ + "Hunts" + ], + "description": "Create or update a hunt", + "operationId": "Hunts_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/Hunt" + } + ], + "responses": { + "200": { + "description": "Create or update the Hunt", + "schema": { + "$ref": "#/definitions/Hunt" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Hunt" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}/relations": { + "get": { + "x-ms-examples": { + "Get all hunt relations.": { + "$ref": "./examples/hunts/GetHuntRelations.json" + } + }, + "tags": [ + "HuntRelations" + ], + "description": "Gets all hunt relations", + "operationId": "HuntRelations_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HuntRelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}/relations/{huntRelationId}": { + "get": { + "x-ms-examples": { + "Get a hunt relation.": { + "$ref": "./examples/hunts/GetHuntRelationById.json" + } + }, + "tags": [ + "HuntRelations" + ], + "description": "Gets a hunt relation", + "operationId": "HuntRelations_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntRelationId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HuntRelation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a hunt relation.": { + "$ref": "./examples/hunts/DeleteHuntRelation.json" + } + }, + "tags": [ + "HuntRelations" + ], + "description": "Delete a hunt relation.", + "operationId": "HuntRelations_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntRelationId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a hunt relation.": { + "$ref": "./examples/hunts/CreateHuntRelation.json" + } + }, + "tags": [ + "HuntRelations" + ], + "description": "Creates or updates a hunt relation.", + "operationId": "HuntRelations_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntRelationId" + }, + { + "$ref": "#/parameters/HuntRelation" + } + ], + "responses": { + "200": { + "description": "Create or update the hunt relation", + "schema": { + "$ref": "#/definitions/HuntRelation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/HuntRelation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}/comments": { + "get": { + "x-ms-examples": { + "Get all hunt comments.": { + "$ref": "./examples/hunts/GetHuntComments.json" + } + }, + "tags": [ + "HuntComments" + ], + "description": "Gets all hunt comments", + "operationId": "HuntComments_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HuntCommentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/hunts/{huntId}/comments/{huntCommentId}": { + "get": { + "x-ms-examples": { + "Get a hunt comment.": { + "$ref": "./examples/hunts/GetHuntCommentById.json" + } + }, + "tags": [ + "HuntComments" + ], + "description": "Gets a hunt comment", + "operationId": "HuntComments_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntCommentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/HuntComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a hunt comment.": { + "$ref": "./examples/hunts/DeleteHuntComment.json" + } + }, + "tags": [ + "HuntComments" + ], + "description": "Delete a hunt comment.", + "operationId": "HuntComments_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntCommentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a hunt comment.": { + "$ref": "./examples/hunts/CreateHuntComment.json" + } + }, + "tags": [ + "HuntComments" + ], + "description": "Creates or updates a hunt relation.", + "operationId": "HuntComments_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/HuntId" + }, + { + "$ref": "#/parameters/HuntCommentId" + }, + { + "$ref": "#/parameters/HuntComment" + } + ], + "responses": { + "200": { + "description": "Create or update the hunt comment", + "schema": { + "$ref": "#/definitions/HuntComment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/HuntComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "HuntList": { + "description": "List all the hunts.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of hunts.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of hunts.", + "items": { + "$ref": "#/definitions/Hunt" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "Hunt": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Hunt in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/HuntProperties", + "description": "Hunt properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "HuntProperties": { + "description": "Describes hunt properties", + "properties": { + "displayName": { + "description": "The display name of the hunt", + "type": "string" + }, + "description": { + "description": "The description of the hunt", + "type": "string" + }, + "status": { + "description": "The status of the hunt.", + "enum": [ + "New", + "Active", + "Closed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "status" + }, + "default": "New" + }, + "hypothesisStatus": { + "description": "The hypothesis status of the hunt.", + "enum": [ + "Unknown", + "Invalidated", + "Validated" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "hypothesisStatus" + }, + "default": "Unknown" + }, + "attackTactics": { + "description": "A list of mitre attack tactics the hunt is associated with", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array" + }, + "attackTechniques": { + "description": "A list of a mitre attack techniques the hunt is associated with", + "items": { + "description": "Attack Technique", + "type": "string" + }, + "type": "array" + }, + "labels": { + "description": "List of labels relevant to this hunt ", + "items": { + "$ref": "../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array" + }, + "owner": { + "$ref": "#/definitions/HuntOwner" + } + }, + "required": [ + "displayName", + "description" + ], + "type": "object" + }, + "HuntRelationList": { + "description": "List of all the hunt relations", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of hunt relations.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of hunt relations", + "items": { + "$ref": "#/definitions/HuntRelation" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "HuntRelation": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Hunt Relation in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/HuntRelationProperties", + "description": "Hunt Relation properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "HuntRelationProperties": { + "description": "Describes hunt relation properties", + "properties": { + "relatedResourceId": { + "description": "The id of the related resource", + "type": "string" + }, + "relatedResourceName": { + "description": "The name of the related resource", + "type": "string", + "readOnly": true + }, + "relationType": { + "description": "The type of the hunt relation", + "type": "string", + "readOnly": true + }, + "relatedResourceKind": { + "description": "The resource that the relation is related to", + "type": "string", + "readOnly": true + }, + "labels": { + "description": "List of labels relevant to this hunt", + "items": { + "$ref": "../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array" + } + }, + "required": [ + "relatedResourceId" + ], + "type": "object" + }, + "HuntCommentList": { + "description": "List of all hunt comments", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of hunt comments.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of hunt comments", + "items": { + "$ref": "#/definitions/HuntComment" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "HuntComment": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Hunt Comment in Azure Security Insights", + "properties": { + "properties": { + "$ref": "#/definitions/HuntCommentProperties", + "description": "Hunt Comment properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "HuntCommentProperties": { + "description": "Describes a hunt comment properties", + "properties": { + "message": { + "description": "The message for the comment", + "type": "string" + } + }, + "required": [ + "message" + ], + "type": "object" + }, + "HuntOwner": { + "description": "Describes a user that the hunt is assigned to", + "type": "object", + "properties": { + "email": { + "description": "The email of the user the hunt is assigned to.", + "type": "string" + }, + "assignedTo": { + "description": "The name of the user the hunt is assigned to.", + "type": "string" + }, + "objectId": { + "description": "The object id of the user the hunt is assigned to.", + "format": "uuid", + "type": "string", + "x-nullable": true + }, + "userPrincipalName": { + "description": "The user principal name of the user the hunt is assigned to.", + "type": "string" + }, + "ownerType": { + "description": "The type of the owner the hunt is assigned to.", + "type": "string", + "enum": [ + "Unknown", + "User", + "Group" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OwnerType", + "values": [ + { + "description": "The hunt owner type is unknown", + "value": "Unknown" + }, + { + "description": "The hunt owner type is an AAD user", + "value": "User" + }, + { + "description": "The hunt owner type is an AAD group", + "value": "Group" + } + ] + } + } + } + } + }, + "parameters": { + "Hunt": { + "description": "The hunt", + "name": "hunt", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Hunt" + }, + "x-ms-parameter-location": "method" + }, + "HuntId": { + "description": "The hunt id (GUID)", + "in": "path", + "name": "huntId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "HuntRelation": { + "description": "The hunt relation", + "in": "body", + "name": "huntRelation", + "required": true, + "schema": { + "$ref": "#/definitions/HuntRelation" + }, + "x-ms-parameter-location": "method" + }, + "HuntRelationId": { + "description": "The hunt relation id (GUID)", + "in": "path", + "name": "huntRelationId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "HuntComment": { + "description": "The hunt comment", + "in": "body", + "name": "huntComment", + "required": true, + "schema": { + "$ref": "#/definitions/HuntComment" + }, + "x-ms-parameter-location": "method" + }, + "HuntCommentId": { + "description": "The hunt comment id (GUID)", + "in": "path", + "name": "huntCommentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Incidents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Incidents.json new file mode 100644 index 000000000000..621a7d16033f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Incidents.json @@ -0,0 +1,1658 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-05-01-preview" + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents": { + "get": { + "tags": [ + "Incidents" + ], + "description": "Gets all incidents.", + "operationId": "Incidents_List", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Incidents_List": { + "$ref": "./examples/incidents/Incidents_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}": { + "get": { + "tags": [ + "Incidents" + ], + "description": "Gets an incident.", + "operationId": "Incidents_Get", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_Get": { + "$ref": "./examples/incidents/Incidents_Get.json" + } + } + }, + "put": { + "tags": [ + "Incidents" + ], + "description": "Creates or updates the incident.", + "operationId": "Incidents_CreateOrUpdate", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/Incident" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_CreateOrUpdate": { + "$ref": "./examples/incidents/Incidents_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "Incidents" + ], + "description": "Delete the incident.", + "operationId": "Incidents_Delete", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_Delete": { + "$ref": "./examples/incidents/Incidents_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/createTeam": { + "post": { + "tags": [ + "IncidentTeam" + ], + "description": "Creates a Microsoft team to investigate the incident by sharing information and insights between participants.", + "operationId": "Incidents_CreateTeam", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/TeamProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TeamInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_CreateTeam": { + "$ref": "./examples/incidents/IncidentTeam/Incidents_CreateTeam.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/alerts": { + "post": { + "tags": [ + "IncidentAlerts" + ], + "description": "Gets all incident alerts.", + "operationId": "Incidents_ListAlerts", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentAlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_ListAlerts": { + "$ref": "./examples/incidents/IncidentAlerts/Incidents_ListAlerts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/bookmarks": { + "post": { + "tags": [ + "IncidentBookmarks" + ], + "description": "Gets all incident bookmarks.", + "operationId": "Incidents_ListBookmarks", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentBookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_ListBookmarks": { + "$ref": "./examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments": { + "get": { + "tags": [ + "IncidentComments" + ], + "description": "Gets all incident comments.", + "operationId": "IncidentComments_List", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentCommentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IncidentComments_List": { + "$ref": "./examples/incidents/IncidentComments/IncidentComments_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}": { + "get": { + "tags": [ + "IncidentComments" + ], + "description": "Gets an incident comment.", + "operationId": "IncidentComments_Get", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentComments_Get": { + "$ref": "./examples/incidents/IncidentComments/IncidentComments_Get.json" + } + } + }, + "put": { + "tags": [ + "IncidentComments" + ], + "description": "Creates or updates the incident comment.", + "operationId": "IncidentComments_CreateOrUpdate", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + }, + { + "$ref": "#/parameters/IncidentComment" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentComments_CreateOrUpdate": { + "$ref": "./examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "IncidentComments" + ], + "description": "Delete the incident comment.", + "operationId": "IncidentComments_Delete", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentComments_Delete": { + "$ref": "./examples/incidents/IncidentComments/IncidentComments_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/entities": { + "post": { + "tags": [ + "IncidentEntities" + ], + "description": "Gets all incident related entities.", + "operationId": "Incidents_ListEntities", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentEntitiesResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Incidents_ListEntities": { + "$ref": "./examples/incidents/IncidentEntities/Incidents_ListEntities.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations": { + "get": { + "x-ms-examples": { + "Get all incident relations.": { + "$ref": "./examples/incidents/relations/GetAllIncidentRelations.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Gets all incident relations.", + "operationId": "IncidentRelations_List", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/RelationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-odata": "./common/RelationTypes.json#/definitions/Relation", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/relations/{relationName}": { + "get": { + "x-ms-examples": { + "Get an incident relation.": { + "$ref": "./examples/incidents/relations/GetIncidentRelationByName.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Gets an incident relation.", + "operationId": "IncidentRelations_Get", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an incident relation.": { + "$ref": "./examples/incidents/relations/CreateIncidentRelation.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Creates or updates the incident relation.", + "operationId": "IncidentRelations_CreateOrUpdate", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/Relation" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "./common/RelationTypes.json#/definitions/Relation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete the incident relation.": { + "$ref": "./examples/incidents/relations/DeleteIncidentRelation.json" + } + }, + "tags": [ + "IncidentRelations" + ], + "description": "Delete the incident relation.", + "operationId": "IncidentRelations_Delete", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "./common/RelationTypes.json#/parameters/RelationName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks": { + "get": { + "tags": [ + "IncidentTasks" + ], + "description": "Gets all incident tasks.", + "operationId": "IncidentTasks_List", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentTaskList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "IncidentTasks_List": { + "$ref": "./examples/incidents/IncidentTasks/IncidentTasks_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/tasks/{incidentTaskId}": { + "get": { + "tags": [ + "IncidentTasks" + ], + "description": "Gets an incident task.", + "operationId": "IncidentTasks_Get", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentTaskId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentTasks_Get": { + "$ref": "./examples/incidents/IncidentTasks/IncidentTasks_Get.json" + } + } + }, + "put": { + "tags": [ + "IncidentTasks" + ], + "description": "Creates or updates the incident task.", + "operationId": "IncidentTasks_CreateOrUpdate", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentTaskId" + }, + { + "$ref": "#/parameters/IncidentTask" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentTasks_CreateOrUpdate": { + "$ref": "./examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "IncidentTasks" + ], + "description": "Delete the incident task.", + "operationId": "IncidentTasks_Delete", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentTaskId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "IncidentTasks_Delete": { + "$ref": "./examples/incidents/IncidentTasks/IncidentTasks_Delete.json" + } + } + } + } + }, + "definitions": { + "Incident": { + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/IncidentProperties", + "x-ms-client-flatten": true + } + } + }, + "IncidentAdditionalData": { + "description": "Incident additional data property bag.", + "type": "object", + "properties": { + "alertsCount": { + "format": "int32", + "description": "The number of alerts in the incident", + "type": "integer", + "readOnly": true + }, + "bookmarksCount": { + "format": "int32", + "description": "The number of bookmarks in the incident", + "type": "integer", + "readOnly": true + }, + "commentsCount": { + "format": "int32", + "description": "The number of comments in the incident", + "type": "integer", + "readOnly": true + }, + "alertProductNames": { + "description": "List of product names of alerts in the incident", + "type": "array", + "items": { + "description": "Alert product name", + "type": "string" + }, + "readOnly": true + }, + "tactics": { + "description": "The tactics associated with incident", + "type": "array", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "readOnly": true + }, + "techniques": { + "description": "The techniques associated with incident's tactics", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "providerIncidentUrl": { + "description": "The provider incident url to the incident in Microsoft 365 Defender portal", + "type": "string", + "readOnly": true + } + } + }, + "IncidentAlertList": { + "description": "List of incident alerts.", + "type": "object", + "properties": { + "value": { + "description": "Array of incident alerts.", + "type": "array", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/SecurityAlert" + } + } + }, + "required": [ + "value" + ] + }, + "IncidentBookmarkList": { + "description": "List of incident bookmarks.", + "type": "object", + "properties": { + "value": { + "description": "Array of incident bookmarks.", + "type": "array", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/HuntingBookmark" + } + } + }, + "required": [ + "value" + ] + }, + "IncidentComment": { + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents an incident comment", + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/IncidentCommentProperties", + "description": "Incident comment properties", + "x-ms-client-flatten": true + } + } + }, + "IncidentCommentList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IncidentComment" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + }, + "required": [ + "value" + ] + }, + "IncidentCommentProperties": { + "description": "Incident comment property bag.", + "required": [ + "message" + ], + "type": "object", + "properties": { + "message": { + "description": "The comment message", + "type": "string" + }, + "createdTimeUtc": { + "format": "date-time", + "description": "The time the comment was created", + "type": "string", + "readOnly": true + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "The time the comment was updated", + "type": "string", + "readOnly": true + }, + "author": { + "type": "object", + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo", + "description": "Describes the client that created the comment", + "readOnly": true + } + } + }, + "IncidentEntitiesResponse": { + "description": "The incident related entities response.", + "type": "object", + "properties": { + "entities": { + "description": "Array of the incident related entities.", + "type": "array", + "items": { + "$ref": "./common/EntityTypes.json#/definitions/Entity" + } + }, + "metaData": { + "description": "The metadata from the incident related entities results.", + "type": "array", + "items": { + "$ref": "#/definitions/IncidentEntitiesResultsMetadata" + } + } + } + }, + "IncidentEntitiesResultsMetadata": { + "description": "Information of a specific aggregation in the incident related entities result.", + "required": [ + "count", + "entityKind" + ], + "type": "object", + "properties": { + "entityKind": { + "description": "The kind of the aggregated entity.", + "$ref": "./common/EntityTypes.json#/definitions/EntityInnerKind" + }, + "count": { + "format": "int32", + "description": "Total number of aggregations of the given kind in the incident related entities result.", + "type": "integer" + } + } + }, + "IncidentList": { + "required": [ + "value" + ], + "description": "List all the incidents.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Incident" + } + }, + "nextLink": { + "description": "URL to fetch the next set of incidents.", + "type": "string", + "readOnly": true + } + } + }, + "IncidentProperties": { + "required": [ + "severity", + "status", + "title" + ], + "type": "object", + "properties": { + "title": { + "description": "The title of the incident", + "type": "string" + }, + "description": { + "description": "The description of the incident", + "type": "string" + }, + "severity": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentSeverityEnum" + }, + "status": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentStatusEnum" + }, + "classification": { + "description": "The reason the incident was closed", + "$ref": "./common/IncidentTypes.json#/definitions/IncidentClassificationEnum" + }, + "classificationReason": { + "description": "The classification reason the incident was closed with", + "$ref": "./common/IncidentTypes.json#/definitions/IncidentClassificationReasonEnum" + }, + "classificationComment": { + "description": "Describes the reason the incident was closed", + "type": "string" + }, + "owner": { + "type": "object", + "description": "Describes a user that the incident is assigned to", + "$ref": "./common/IncidentTypes.json#/definitions/IncidentOwnerInfo" + }, + "labels": { + "description": "List of labels relevant to this incident", + "type": "array", + "items": { + "$ref": "./common/IncidentTypes.json#/definitions/IncidentLabel" + } + }, + "firstActivityTimeUtc": { + "format": "date-time", + "description": "The time of the first activity in the incident", + "type": "string" + }, + "lastActivityTimeUtc": { + "format": "date-time", + "description": "The time of the last activity in the incident", + "type": "string" + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "The last time the incident was updated", + "type": "string", + "readOnly": true + }, + "createdTimeUtc": { + "format": "date-time", + "description": "The time the incident was created", + "type": "string", + "readOnly": true + }, + "incidentNumber": { + "format": "int32", + "description": "A sequential number", + "type": "integer", + "readOnly": true + }, + "additionalData": { + "$ref": "#/definitions/IncidentAdditionalData", + "description": "Additional data on the incident", + "readOnly": true, + "type": "object" + }, + "relatedAnalyticRuleIds": { + "description": "List of resource ids of Analytic rules related to the incident", + "type": "array", + "items": { + "description": "Related Analytic rule resource id", + "type": "string" + }, + "readOnly": true + }, + "incidentUrl": { + "description": "The deep-link url to the incident in Azure portal", + "type": "string", + "readOnly": true + }, + "providerName": { + "description": "The name of the source provider that generated the incident", + "type": "string", + "readOnly": true + }, + "providerIncidentId": { + "description": "The incident ID assigned by the incident provider", + "type": "string", + "readOnly": true + }, + "teamInformation": { + "$ref": "#/definitions/TeamInformation", + "description": "Describes a team for the incident", + "type": "object" + } + } + }, + "IncidentTask": { + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "type": "object", + "$ref": "#/definitions/IncidentTaskProperties", + "x-ms-client-flatten": true + } + } + }, + "IncidentTaskList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IncidentTask" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "IncidentTaskProperties": { + "required": [ + "status", + "title" + ], + "type": "object", + "properties": { + "title": { + "description": "The title of the task", + "type": "string" + }, + "description": { + "description": "The description of the task", + "type": "string" + }, + "status": { + "$ref": "#/definitions/IncidentTaskStatus" + }, + "createdTimeUtc": { + "format": "date-time", + "description": "The time the task was created", + "type": "string", + "readOnly": true + }, + "lastModifiedTimeUtc": { + "format": "date-time", + "description": "The last time the task was updated", + "type": "string", + "readOnly": true + }, + "createdBy": { + "type": "object", + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo" + }, + "lastModifiedBy": { + "type": "object", + "$ref": "../../../common/2.0/types.json#/definitions/ClientInfo" + } + } + }, + "IncidentTaskStatus": { + "enum": [ + "New", + "Completed" + ], + "type": "string", + "example": "New", + "x-ms-enum": { + "name": "IncidentTaskStatus", + "modelAsString": true, + "values": [ + { + "value": "New", + "description": "A new task" + }, + { + "value": "Completed", + "description": "A completed task" + } + ] + } + }, + "TeamInformation": { + "description": "Describes team information", + "type": "object", + "properties": { + "teamId": { + "description": "Team ID", + "type": "string", + "readOnly": true + }, + "primaryChannelUrl": { + "description": "The primary channel URL of the team", + "type": "string", + "readOnly": true + }, + "teamCreationTimeUtc": { + "format": "date-time", + "description": "The time the team was created", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the team", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the team", + "type": "string", + "readOnly": true + } + } + }, + "TeamProperties": { + "description": "Describes team properties", + "required": [ + "teamName" + ], + "type": "object", + "properties": { + "teamName": { + "description": "The name of the team", + "type": "string" + }, + "teamDescription": { + "description": "The description of the team", + "type": "string" + }, + "groupIds": { + "description": "List of group IDs to add their members to the team", + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } + }, + "memberIds": { + "description": "List of member IDs to add to the team", + "type": "array", + "items": { + "format": "uuid", + "type": "string" + } + } + } + } + }, + "parameters": { + "Incident": { + "name": "incident", + "description": "The incident", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "IncidentId": { + "in": "path", + "name": "incidentId", + "description": "Incident ID", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "IncidentComment": { + "name": "incidentComment", + "description": "The incident comment", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "IncidentCommentId": { + "in": "path", + "name": "incidentCommentId", + "description": "Incident comment ID", + "required": true, + "x-ms-parameter-location": "method", + "type": "string" + }, + "TeamProperties": { + "name": "teamProperties", + "description": "Team properties", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/TeamInformation" + } + }, + "IncidentTask": { + "name": "incidentTask", + "description": "The incident task", + "required": true, + "in": "body", + "x-ms-parameter-location": "method", + "schema": { + "$ref": "#/definitions/IncidentTask" + } + }, + "IncidentTaskId": { + "in": "path", + "name": "incidentTaskId", + "description": "Incident task ID", + "required": true, + "x-ms-parameter-location": "method", + "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" + ] + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Metadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Metadata.json new file mode 100644 index 000000000000..b9b9de213d30 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Metadata.json @@ -0,0 +1,824 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata": { + "get": { + "x-ms-examples": { + "Get all metadata.": { + "$ref": "./examples/metadata/GetAllMetadata.json" + }, + "Get all metadata with OData filter/orderby/skip/top": { + "$ref": "./examples/metadata/GetAllMetadataOData.json" + } + }, + "tags": [ + "Metadata" + ], + "description": "List of all metadata", + "operationId": "Metadata_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkip" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetadataList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/metadata/{metadataName}": { + "get": { + "x-ms-examples": { + "Get single metadata by name": { + "$ref": "./examples/metadata/GetMetadata.json" + } + }, + "tags": [ + "Metadata" + ], + "description": "Get a Metadata.", + "operationId": "Metadata_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/MetadataName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetadataModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete metadata.": { + "$ref": "./examples/metadata/DeleteMetadata.json" + } + }, + "tags": [ + "Metadata" + ], + "description": "Delete a Metadata.", + "operationId": "Metadata_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/MetadataName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create/update full metadata.": { + "$ref": "./examples/metadata/PutMetadata.json" + }, + "Create/update minimal metadata.": { + "$ref": "./examples/metadata/PutMetadataMinimal.json" + } + }, + "tags": [ + "Metadata" + ], + "description": "Create a Metadata.", + "operationId": "Metadata_Create", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/MetadataName" + }, + { + "$ref": "#/parameters/Metadata" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/MetadataModel" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MetadataModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Update metadata.": { + "$ref": "./examples/metadata/PatchMetadata.json" + } + }, + "tags": [ + "Metadata" + ], + "description": "Update an existing Metadata.", + "operationId": "Metadata_Update", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/MetadataName" + }, + { + "$ref": "#/parameters/MetadataPatch" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MetadataModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "MetadataList": { + "description": "List of all the metadata.", + "type": "object", + "properties": { + "value": { + "description": "Array of metadata.", + "items": { + "$ref": "#/definitions/MetadataModel" + }, + "type": "array" + }, + "nextLink": { + "description": "URL to fetch the next page of metadata.", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "MetadataModel": { + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Metadata resource definition.", + "properties": { + "properties": { + "$ref": "#/definitions/metadataProperties", + "description": "Metadata properties", + "x-ms-client-flatten": true + } + } + }, + "metadataPatch": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Metadata patch request body.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/metadataPropertiesPatch", + "description": "Metadata patch request body", + "x-ms-client-flatten": true + } + } + }, + "metadataContentId": { + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a template, both will have the same contentId.", + "type": "string" + }, + "metadataParentId": { + "description": "Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)", + "type": "string" + }, + "metadataVersion": { + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks", + "type": "string" + }, + "metadataKind": { + "type": "string", + "description": "The kind of content the metadata is for." + }, + "metadataSource": { + "description": "The original source of the content item, where it comes from.", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "description": "Source type of the content", + "type": "string", + "enum": [ + "LocalWorkspace", + "Community", + "Solution", + "SourceRepository" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "sourceKind", + "values": [ + { + "value": "LocalWorkspace" + }, + { + "value": "Community" + }, + { + "value": "Solution" + }, + { + "value": "SourceRepository" + } + ] + } + }, + "name": { + "description": "Name of the content source. The repo name, solution name, LA workspace name etc.", + "type": "string" + }, + "sourceId": { + "description": "ID of the content source. The solution ID, workspace ID, etc", + "type": "string" + } + } + }, + "metadataAuthor": { + "type": "object", + "description": "Publisher or creator of the content item.", + "properties": { + "name": { + "description": "Name of the author. Company or person.", + "type": "string" + }, + "email": { + "description": "Email of author contact", + "type": "string" + }, + "link": { + "description": "Link for author/vendor page", + "type": "string" + } + } + }, + "metadataSupport": { + "type": "object", + "description": "Support information for the content item.", + "required": [ + "tier" + ], + "properties": { + "tier": { + "description": "Type of support for content item", + "type": "string", + "enum": [ + "Microsoft", + "Partner", + "Community" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "supportTier", + "values": [ + { + "value": "Microsoft" + }, + { + "value": "Partner" + }, + { + "value": "Community" + } + ] + } + }, + "name": { + "description": "Name of the support contact. Company or person.", + "type": "string" + }, + "email": { + "description": "Email of support contact", + "type": "string" + }, + "link": { + "description": "Link for support help, like to support page to open a ticket etc.", + "type": "string" + } + } + }, + "metadataDependencies": { + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies.", + "type": "object", + "properties": { + "contentId": { + "description": "Id of the content item we depend on", + "$ref": "#/definitions/metadataContentId" + }, + "kind": { + "description": "Type of the content item we depend on", + "$ref": "#/definitions/metadataKind" + }, + "version": { + "description": "Version of the the content item we depend on. Can be blank, * or missing to indicate any version fulfills the dependency. If version does not match our defined numeric format then an exact match is required.", + "$ref": "#/definitions/metadataVersion" + }, + "name": { + "description": "Name of the content item", + "type": "string" + }, + "operator": { + "description": "Operator used for list of dependencies in criteria array.", + "type": "string", + "enum": [ + "AND", + "OR" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "operator", + "values": [ + { + "value": "AND" + }, + { + "value": "OR" + } + ] + } + }, + "criteria": { + "description": "This is the list of dependencies we must fulfill, according to the AND/OR operator", + "type": "array", + "items": { + "$ref": "#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + } + } + } + }, + "metadataCategories": { + "type": "object", + "description": "ies for the solution content item", + "properties": { + "domains": { + "description": "domain for the solution content item", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "verticals": { + "description": "Industry verticals for the solution content item", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "str1", + "str2", + "str3" + ] + } + } + }, + "metadataProviders": { + "description": "Providers for the solution content item", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "firstPublishDate": { + "description": "first publish date of solution content item", + "type": "string", + "format": "date" + }, + "lastPublishDate": { + "description": "last publish date of solution content item", + "type": "string", + "format": "date" + }, + "metadataCustomVersion": { + "description": "The custom version of the content. A optional free text", + "type": "string" + }, + "metadataContentSchemaVersion": { + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version", + "type": "string" + }, + "metadataIcon": { + "description": "the icon identifier. this id can later be fetched from the solution template", + "type": "string" + }, + "metadataThreatAnalysisTactics": { + "description": "the tactics the resource covers", + "type": "array", + "example": [ + "reconnaissance", + "exfiltration" + ], + "items": { + "type": "string" + } + }, + "metadataThreatAnalysisTechniques": { + "description": "the techniques the resource covers, these have to be aligned with the tactics being used", + "type": "array", + "example": [ + "T1548", + "T1548.001", + "T1134.003" + ], + "items": { + "type": "string" + } + }, + "metadataPreviewImages": { + "description": "preview image file names. These will be taken from the solution artifacts", + "type": "array", + "example": [ + "example.png", + "example2.jpeg" + ], + "items": { + "type": "string" + } + }, + "metadataPreviewImagesDark": { + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support", + "type": "array", + "example": [ + "example.png", + "example2.jpeg" + ], + "items": { + "type": "string" + } + }, + "metadataProperties": { + "description": "Metadata property bag.", + "required": [ + "parentId", + "kind" + ], + "type": "object", + "properties": { + "contentId": { + "$ref": "#/definitions/metadataContentId", + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name" + }, + "parentId": { + "$ref": "#/definitions/metadataParentId", + "description": "Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)" + }, + "version": { + "$ref": "#/definitions/metadataVersion", + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "kind": { + "$ref": "#/definitions/metadataKind", + "description": "The kind of content the metadata is for." + }, + "source": { + "$ref": "#/definitions/metadataSource", + "description": "Source of the content. This is where/how it was created." + }, + "author": { + "$ref": "#/definitions/metadataAuthor", + "description": "The creator of the content item." + }, + "support": { + "$ref": "#/definitions/metadataSupport", + "description": "Support information for the metadata - type, name, contact information" + }, + "dependencies": { + "$ref": "#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "categories": { + "$ref": "#/definitions/metadataCategories", + "description": "Categories for the solution content item" + }, + "providers": { + "$ref": "#/definitions/metadataProviders", + "description": "Providers for the solution content item" + }, + "firstPublishDate": { + "$ref": "#/definitions/firstPublishDate", + "description": "first publish date solution content item" + }, + "lastPublishDate": { + "$ref": "#/definitions/lastPublishDate", + "description": "last publish date for the solution content item" + }, + "customVersion": { + "$ref": "#/definitions/metadataCustomVersion", + "description": "The custom version of the content. A optional free text" + }, + "contentSchemaVersion": { + "$ref": "#/definitions/metadataContentSchemaVersion", + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version" + }, + "icon": { + "$ref": "#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the solution template" + }, + "threatAnalysisTactics": { + "$ref": "#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "previewImages": { + "$ref": "#/definitions/metadataPreviewImages", + "description": "preview image file names. These will be taken from the solution artifacts" + }, + "previewImagesDark": { + "$ref": "#/definitions/metadataPreviewImagesDark", + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support" + } + } + }, + "metadataPropertiesPatch": { + "description": "Metadata property bag for patch requests. This is the same as the MetadataProperties, but with nothing required", + "type": "object", + "properties": { + "contentId": { + "$ref": "#/definitions/metadataContentId", + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Dynamic for user-created. This is the resource name" + }, + "parentId": { + "$ref": "#/definitions/metadataParentId", + "description": "Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)" + }, + "version": { + "$ref": "#/definitions/metadataVersion", + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks" + }, + "kind": { + "$ref": "#/definitions/metadataKind", + "description": "The kind of content the metadata is for." + }, + "source": { + "$ref": "#/definitions/metadataSource", + "description": "Source of the content. This is where/how it was created." + }, + "author": { + "$ref": "#/definitions/metadataAuthor", + "description": "The creator of the content item." + }, + "support": { + "$ref": "#/definitions/metadataSupport", + "description": "Support information for the metadata - type, name, contact information" + }, + "dependencies": { + "$ref": "#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "categories": { + "$ref": "#/definitions/metadataCategories", + "description": "Categories for the solution content item" + }, + "providers": { + "$ref": "#/definitions/metadataProviders", + "description": "Providers for the solution content item" + }, + "firstPublishDate": { + "$ref": "#/definitions/firstPublishDate", + "description": "first publish date solution content item" + }, + "lastPublishDate": { + "$ref": "#/definitions/lastPublishDate", + "description": "last publish date for the solution content item" + }, + "customVersion": { + "$ref": "#/definitions/metadataCustomVersion", + "description": "The custom version of the content. A optional free text" + }, + "contentSchemaVersion": { + "$ref": "#/definitions/metadataContentSchemaVersion", + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version" + }, + "icon": { + "$ref": "#/definitions/metadataIcon", + "description": "the icon identifier. this id can later be fetched from the solution template" + }, + "threatAnalysisTactics": { + "$ref": "#/definitions/metadataThreatAnalysisTactics", + "description": "the tactics the resource covers" + }, + "threatAnalysisTechniques": { + "$ref": "#/definitions/metadataThreatAnalysisTechniques", + "description": "the techniques the resource covers, these have to be aligned with the tactics being used" + }, + "previewImages": { + "$ref": "#/definitions/metadataPreviewImages", + "description": "preview image file names. These will be taken from the solution artifacts" + }, + "previewImagesDark": { + "$ref": "#/definitions/metadataPreviewImagesDark", + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support" + } + } + } + }, + "parameters": { + "Metadata": { + "description": "Metadata resource.", + "in": "body", + "name": "metadata", + "required": true, + "schema": { + "$ref": "#/definitions/MetadataModel" + }, + "x-ms-parameter-location": "method" + }, + "MetadataPatch": { + "description": "Partial metadata request.", + "in": "body", + "name": "metadataPatch", + "required": true, + "schema": { + "$ref": "#/definitions/metadataPatch" + }, + "x-ms-parameter-location": "method" + }, + "MetadataName": { + "description": "The Metadata name.", + "in": "path", + "name": "metadataName", + "required": true, + "pattern": "^\\S+$", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/OfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/OfficeConsents.json new file mode 100644 index 000000000000..500254a12236 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/OfficeConsents.json @@ -0,0 +1,234 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/officeConsents": { + "get": { + "x-ms-examples": { + "Get all office consents.": { + "$ref": "./examples/officeConsents/GetOfficeConsents.json" + } + }, + "tags": [ + "Office Consents" + ], + "description": "Gets all office365 consents.", + "operationId": "OfficeConsents_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfficeConsentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/officeConsents/{consentId}": { + "get": { + "x-ms-examples": { + "Get an office consent.": { + "$ref": "./examples/officeConsents/GetOfficeConsentsById.json" + } + }, + "tags": [ + "Office Consents" + ], + "description": "Gets an office365 consent.", + "operationId": "OfficeConsents_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ConsentId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OfficeConsent" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an office consent.": { + "$ref": "./examples/officeConsents/DeleteOfficeConsents.json" + } + }, + "tags": [ + "Office Consents" + ], + "description": "Delete the office365 consent.", + "operationId": "OfficeConsents_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ConsentId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "ConsentId": { + "description": "consent ID", + "in": "path", + "name": "consentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "OfficeConsent": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "description": "Consent for Office365 tenant that already made.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeConsentProperties", + "description": "Office consent properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "OfficeConsentList": { + "description": "List of all the office365 consents.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of office consents.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of the consents.", + "items": { + "$ref": "#/definitions/OfficeConsent" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "OfficeConsentProperties": { + "description": "Consent property bag.", + "properties": { + "tenantId": { + "description": "The tenantId of the Office365 with the consent.", + "type": "string" + }, + "consentId": { + "description": "Help to easily cascade among the data layers.", + "type": "string" + } + }, + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/OnboardingStates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/OnboardingStates.json new file mode 100644 index 000000000000..68f15a1980b7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/OnboardingStates.json @@ -0,0 +1,284 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates/{sentinelOnboardingStateName}": { + "get": { + "x-ms-examples": { + "Get Sentinel onboarding state": { + "$ref": "./examples/onboardingStates/GetSentinelOnboardingState.json" + } + }, + "tags": [ + "SentinelOnboardingStates" + ], + "description": "Get Sentinel onboarding state", + "operationId": "SentinelOnboardingStates_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SentinelOnboardingStateName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SentinelOnboardingState" + } + }, + "default": { + "description": "Error in getting the Sentinel onboarding state", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create Sentinel onboarding state": { + "$ref": "./examples/onboardingStates/CreateSentinelOnboardingState.json" + } + }, + "tags": [ + "SentinelOnboardingStates" + ], + "description": "Create Sentinel onboarding state", + "operationId": "SentinelOnboardingStates_Create", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SentinelOnboardingStateName" + }, + { + "$ref": "#/parameters/SentinelOnboardingStateParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SentinelOnboardingState" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SentinelOnboardingState" + } + }, + "default": { + "description": "Error in creating the Sentinel onboarding state", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete Sentinel onboarding state": { + "$ref": "./examples/onboardingStates/DeleteSentinelOnboardingState.json" + } + }, + "tags": [ + "SentinelOnboardingStates" + ], + "description": "Delete Sentinel onboarding state", + "operationId": "SentinelOnboardingStates_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SentinelOnboardingStateName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error in deleting the Sentinel onboarding state", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/onboardingStates": { + "get": { + "x-ms-examples": { + "Get all Sentinel onboarding states": { + "$ref": "./examples/onboardingStates/GetAllSentinelOnboardingStates.json" + } + }, + "tags": [ + "SentinelOnboardingStates" + ], + "description": "Gets all Sentinel onboarding states", + "operationId": "SentinelOnboardingStates_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SentinelOnboardingStatesList" + } + }, + "default": { + "description": "Error in listing the Sentinel onboarding states", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "SentinelOnboardingStateProperties": { + "description": "The Sentinel onboarding state properties", + "type": "object", + "properties": { + "customerManagedKey": { + "description": "Flag that indicates the status of the CMK setting", + "type": "boolean" + } + } + }, + "SentinelOnboardingState": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Sentinel onboarding state", + "properties": { + "properties": { + "$ref": "#/definitions/SentinelOnboardingStateProperties", + "description": "The Sentinel onboarding state object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "SentinelOnboardingStatesList": { + "description": "List of the Sentinel onboarding states", + "properties": { + "value": { + "description": "Array of Sentinel onboarding states", + "items": { + "$ref": "#/definitions/SentinelOnboardingState" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + } + }, + "parameters": { + "SentinelOnboardingStateName": { + "description": "The Sentinel onboarding state name. Supports - default", + "in": "path", + "name": "sentinelOnboardingStateName", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SentinelOnboardingStateParameter": { + "description": "The Sentinel onboarding state parameter", + "in": "body", + "name": "sentinelOnboardingStateParameter", + "required": false, + "schema": { + "$ref": "#/definitions/SentinelOnboardingState" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Recommendations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Recommendations.json new file mode 100644 index 000000000000..73ffa795aa86 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Recommendations.json @@ -0,0 +1,564 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/recommendations": { + "get": { + "x-ms-examples": { + "Get Recommendations list.": { + "$ref": "./examples/recommendations/GetRecommendations.json" + } + }, + "tags": [ + "recommendations" + ], + "description": "Gets a list of all recommendations.", + "operationId": "GetRecommendations_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecommendationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/recommendations/{recommendationId}": { + "get": { + "x-ms-examples": { + "Get a recommendation.": { + "$ref": "./examples/recommendations/GetRecommendation.json" + } + }, + "tags": [ + "recommendations" + ], + "description": "Gets a recommendation by its id.", + "operationId": "Get_SingleRecommendation", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RecommendationId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Recommendation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "patch": { + "x-ms-examples": { + "Creates a recommendation.": { + "$ref": "./examples/recommendations/PatchRecommendation.json" + } + }, + "tags": [ + "recommendations" + ], + "description": "Patch a recommendation.", + "operationId": "Update_Recommendation", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RecommendationId" + }, + { + "$ref": "#/parameters/RecommendationPatch" + } + ], + "x-ms-long-running-operation": true, + "responses": { + "202": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Recommendation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "Recommendation": { + "description": "Recommendation object.", + "properties": { + "id": { + "description": "id of recommendation.", + "type": "string", + "format": "uuid" + }, + "instructions": { + "description": "Instructions of the recommendation.", + "$ref": "#/definitions/Instructions" + }, + "content": { + "description": "Content of the recommendation.", + "$ref": "#/definitions/Content", + "x-nullable": true + }, + "resourceId": { + "description": "Id of the resource this recommendation refers to.", + "type": "string", + "x-nullable": true + }, + "additionalProperties": { + "description": "Collection of additional properties for the recommendation.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-nullable": true + }, + "title": { + "description": "Title of the recommendation.", + "type": "string" + }, + "description": { + "description": "Description of the recommendation.", + "type": "string" + }, + "recommendationTypeTitle": { + "description": "Title of the recommendation type.", + "type": "string" + }, + "recommendationTypeId": { + "description": "Id of the recommendation type.", + "type": "string" + }, + "category": { + "description": "Category of the recommendation.", + "$ref": "#/definitions/RecommendationCategory" + }, + "context": { + "description": "Context of the recommendation.", + "$ref": "#/definitions/RecommendationContext" + }, + "workspaceId": { + "description": "Id of the workspace this recommendation refers to.", + "type": "string", + "format": "uuid" + }, + "actions": { + "description": "List of actions to take for this recommendation.", + "type": "array", + "items": { + "$ref": "#/definitions/RecommendedAction" + }, + "x-ms-identifiers": [] + }, + "state": { + "description": "State of the recommendation.", + "$ref": "#/definitions/RecommendationState" + }, + "priority": { + "description": "Priority of the recommendation.", + "$ref": "#/definitions/RecommendationPriority" + }, + "lastEvaluatedTimeUtc": { + "description": "The time stamp (UTC) when the recommendation was last evaluated.", + "type": "string", + "format": "date-time" + }, + "hideUntilTimeUtc": { + "description": "The time stamp (UTC) when the recommendation should be displayed again.", + "type": "string", + "format": "date-time", + "x-nullable": true + }, + "displayUntilTimeUtc": { + "description": "The timestamp (UTC) after which the recommendation should not be displayed anymore.", + "type": "string", + "format": "date-time", + "x-nullable": true + }, + "visible": { + "description": "Value indicating if the recommendation should be displayed or not.", + "type": "boolean" + } + }, + "required": [ + "id", + "instructions", + "title", + "description", + "recommendationTypeTitle", + "recommendationTypeId", + "category", + "context", + "workspaceId", + "actions", + "state", + "priority", + "lastEvaluatedTimeUtc" + ], + "type": "object" + }, + "RecommendationList": { + "description": "A list of recommendations", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Recommendation" + }, + "description": "An list of recommendations" + } + }, + "type": "object" + }, + "Content": { + "description": "Content section of the recommendation.", + "properties": { + "title": { + "description": "Title of the content.", + "type": "string" + }, + "description": { + "description": "Description of the content.", + "type": "string" + } + }, + "required": [ + "title", + "description" + ], + "type": "object" + }, + "Instructions": { + "description": "Instructions section of a recommendation.", + "properties": { + "actionsToBePerformed": { + "description": "What actions should be taken to complete the recommendation.", + "type": "string" + }, + "recommendationImportance": { + "description": "Explains why the recommendation is important.", + "type": "string" + }, + "howToPerformActionDetails": { + "description": "How should the user complete the recommendation.", + "type": "string", + "x-nullable": true + } + }, + "required": [ + "actionsToBePerformed", + "recommendationImportance" + ], + "type": "object" + }, + "RecommendedAction": { + "description": "What actions should be taken to complete the recommendation.", + "properties": { + "linkText": { + "description": "Text of the link to complete the action.", + "type": "string" + }, + "linkUrl": { + "description": "The Link to complete the action.", + "type": "string" + }, + "state": { + "description": "The state of the action.", + "$ref": "#/definitions/ActionState" + } + }, + "required": [ + "linkText", + "linkUrl" + ], + "type": "object" + }, + "RecommendationPatch": { + "description": "Recommendation Fields to update.", + "properties": { + "state": { + "description": "State of the recommendation.", + "$ref": "#/definitions/RecommendationState" + }, + "hideUntilTimeUtc": { + "description": "The time stamp (UTC) when the recommendation should be displayed again.", + "type": "string", + "format": "date-time" + } + }, + "type": "object" + }, + "RecommendationCategory": { + "description": "Categories of recommendations.", + "type": "string", + "enum": [ + "Onboarding", + "NewFeature", + "SocEfficiency", + "CostOptimization", + "Demo" + ], + "x-ms-enum": { + "name": "Category", + "modelAsString": true, + "values": [ + { + "value": "Onboarding", + "description": "Onboarding recommendation." + }, + { + "value": "NewFeature", + "description": "New feature recommendation." + }, + { + "value": "SocEfficiency", + "description": "Soc Efficiency recommendation." + }, + { + "value": "CostOptimization", + "description": "Cost optimization recommendation." + }, + { + "value": "Demo", + "description": "Demo recommendation." + } + ] + } + }, + "RecommendationContext": { + "description": "Context of recommendation.", + "type": "string", + "enum": [ + "Analytics", + "Incidents", + "Overview", + "None" + ], + "x-ms-enum": { + "name": "Context", + "modelAsString": true, + "values": [ + { + "value": "Analytics", + "description": "Analytics context." + }, + { + "value": "Incidents", + "description": "Incidents context." + }, + { + "value": "Overview", + "description": "Overview context." + }, + { + "value": "None", + "description": "No context." + } + ] + } + }, + "RecommendationState": { + "description": "State of recommendation.", + "type": "string", + "enum": [ + "Active", + "Disabled", + "CompletedByUser", + "CompletedByAction", + "Hidden" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true, + "values": [ + { + "value": "Active", + "description": "Recommendation is active." + }, + { + "value": "Disabled", + "description": "Recommendation is disabled." + }, + { + "value": "CompletedByUser", + "description": "Recommendation has been completed by user." + }, + { + "value": "CompletedByAction", + "description": "Recommendation has been completed by action." + }, + { + "value": "Hidden", + "description": "Recommendation is hidden." + } + ] + } + }, + "RecommendationPriority": { + "description": "Priority of recommendation.", + "type": "string", + "enum": [ + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "Priority", + "modelAsString": true, + "values": [ + { + "value": "Low", + "description": "Low priority for recommendation." + }, + { + "value": "Medium", + "description": "Medium priority for recommendation." + }, + { + "value": "High", + "description": "High priority for recommendation." + } + ] + } + }, + "ActionState": { + "description": "Represents the state the recommendation action is currently in.", + "type": "string", + "enum": [ + "Active", + "InProgress", + "Done" + ], + "x-ms-enum": { + "name": "Priority", + "modelAsString": true, + "values": [ + { + "value": "Active", + "description": "Default state of actions." + }, + { + "value": "InProgress", + "description": "State for when actions have been clicked on." + }, + { + "value": "Done", + "description": "State of completed actions." + } + ] + } + } + }, + "parameters": { + "RecommendationId": { + "description": "Recommendation Id.", + "in": "path", + "name": "recommendationId", + "required": true, + "type": "string", + "format": "uuid", + "x-ms-parameter-location": "method" + }, + "RecommendationPatch": { + "description": "Recommendation Fields to Update.", + "in": "body", + "name": "recommendationPatch", + "required": true, + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/RecommendationPatch" + }, + "x-ms-identifiers": [] + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/SecurityMLAnalyticsSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/SecurityMLAnalyticsSettings.json new file mode 100644 index 000000000000..00fa269634b2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/SecurityMLAnalyticsSettings.json @@ -0,0 +1,444 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings": { + "get": { + "x-ms-examples": { + "Get all Security ML Analytics Settings.": { + "$ref": "./examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json" + } + }, + "tags": [ + "Security ML Analytics Settings" + ], + "description": "Gets all Security ML Analytics Settings.", + "operationId": "SecurityMLAnalyticsSettings_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityMLAnalyticsSettingsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/{settingsResourceName}": { + "get": { + "x-ms-examples": { + "Get a Anomaly Security ML Analytics Settings.": { + "$ref": "./examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json" + } + }, + "tags": [ + "Security ML Analytics Settings" + ], + "description": "Gets the Security ML Analytics Settings.", + "operationId": "SecurityMLAnalyticsSettings_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsResourceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a Anomaly Security ML Analytics Settings.": { + "$ref": "./examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json" + } + }, + "tags": [ + "Security ML Analytics Settings" + ], + "description": "Creates or updates the Security ML Analytics Settings.", + "operationId": "SecurityMLAnalyticsSettings_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsResourceName" + }, + { + "$ref": "#/parameters/SecurityMLAnalyticsSetting" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a Security ML Analytics Settings.": { + "$ref": "./examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json" + } + }, + "tags": [ + "Security ML Analytics Settings" + ], + "description": "Delete the Security ML Analytics Settings.", + "operationId": "SecurityMLAnalyticsSettings_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsResourceName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "SecurityMLAnalyticsSetting": { + "description": "The security ML Analytics setting", + "in": "body", + "name": "securityMLAnalyticsSetting", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + }, + "x-ms-parameter-location": "method" + }, + "SettingsResourceName": { + "description": "Security ML Analytics Settings resource name", + "in": "path", + "name": "settingsResourceName", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "SecurityMLAnalyticsSetting": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Security ML Analytics Setting", + "properties": { + "kind": { + "$ref": "#/definitions/SecurityMLAnalyticsSettingsKindEnum", + "description": "The kind of security ML Analytics Settings" + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "SecurityMLAnalyticsSettingsKindEnum": { + "description": "The kind of security ML analytics settings", + "enum": [ + "Anomaly" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SecurityMLAnalyticsSettingsKind", + "values": [ + { + "value": "Anomaly" + } + ] + } + }, + "SecurityMLAnalyticsSettingsList": { + "description": "List all the SecurityMLAnalyticsSettings", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of SecurityMLAnalyticsSettings.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of SecurityMLAnalyticsSettings", + "items": { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "AnomalySecurityMLAnalyticsSettings": { + "allOf": [ + { + "$ref": "#/definitions/SecurityMLAnalyticsSetting" + } + ], + "description": "Represents Anomaly Security ML Analytics Settings", + "properties": { + "properties": { + "$ref": "#/definitions/AnomalySecurityMLAnalyticsSettingsProperties", + "description": "Anomaly Security ML Analytics Settings properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Anomaly" + }, + "AnomalySecurityMLAnalyticsSettingsProperties": { + "description": "AnomalySecurityMLAnalytics settings base property bag.", + "properties": { + "description": { + "description": "The description of the SecurityMLAnalyticsSettings.", + "type": "string" + }, + "displayName": { + "description": "The display name for settings created by this SecurityMLAnalyticsSettings.", + "type": "string" + }, + "enabled": { + "description": "Determines whether this settings is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this SecurityMLAnalyticsSettings has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data sources for this SecurityMLAnalyticsSettings", + "items": { + "$ref": "#/definitions/SecurityMLAnalyticsSettingsDataSource" + }, + "x-ms-identifiers": [ + "connectorId" + ], + "type": "array" + }, + "tactics": { + "description": "The tactics of the SecurityMLAnalyticsSettings", + "items": { + "$ref": "./common/AlertTypes.json#/definitions/AttackTactic" + }, + "type": "array" + }, + "techniques": { + "description": "The techniques of the SecurityMLAnalyticsSettings", + "items": { + "type": "string" + }, + "type": "array" + }, + "anomalyVersion": { + "description": "The anomaly version of the AnomalySecurityMLAnalyticsSettings.", + "type": "string" + }, + "customizableObservations": { + "description": "The customizable observations of the AnomalySecurityMLAnalyticsSettings.", + "type": "object" + }, + "frequency": { + "description": "The frequency that this SecurityMLAnalyticsSettings will be run.", + "format": "duration", + "type": "string" + }, + "settingsStatus": { + "$ref": "#/definitions/AnomalySecurityMLAnalyticsSettingsStatus", + "description": "The anomaly SecurityMLAnalyticsSettings status" + }, + "isDefaultSettings": { + "description": "Determines whether this anomaly security ml analytics settings is a default settings", + "type": "boolean" + }, + "anomalySettingsVersion": { + "description": "The anomaly settings version of the Anomaly security ml analytics settings that dictates whether job version gets updated or not.", + "type": "integer", + "format": "int32" + }, + "settingsDefinitionId": { + "description": "The anomaly settings definition Id", + "format": "uuid", + "type": "string" + } + }, + "required": [ + "displayName", + "enabled", + "anomalyVersion", + "frequency", + "settingsStatus", + "isDefaultSettings" + ], + "type": "object" + }, + "SecurityMLAnalyticsSettingsDataSource": { + "description": "security ml analytics settings data sources", + "properties": { + "connectorId": { + "description": "The connector id that provides the following data types", + "type": "string" + }, + "dataTypes": { + "description": "The data types used by the security ml analytics settings", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AnomalySecurityMLAnalyticsSettingsStatus": { + "description": "The anomaly SecurityMLAnalyticsSettings status", + "enum": [ + "Production", + "Flighting" + ], + "type": "string", + "x-ms-enum": { + "name": "SettingsStatus", + "modelAsString": true, + "values": [ + { + "description": "Anomaly settings status in Production mode", + "value": "Production" + }, + { + "description": "Anomaly settings status in Flighting mode", + "value": "Flighting" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Settings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Settings.json new file mode 100644 index 000000000000..7bd7e6013570 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Settings.json @@ -0,0 +1,423 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings": { + "get": { + "x-ms-examples": { + "Get all settings.": { + "$ref": "./examples/settings/GetAllSettings.json" + } + }, + "tags": [ + "Settings" + ], + "description": "List of all the settings", + "operationId": "ProductSettings_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/settings/{settingsName}": { + "get": { + "x-ms-examples": { + "Get EyesOn settings.": { + "$ref": "./examples/settings/GetEyesOnSetting.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Gets a setting.", + "operationId": "ProductSettings_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Settings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete EyesOn settings.": { + "$ref": "./examples/settings/DeleteEyesOnSetting.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Delete setting of the product.", + "operationId": "ProductSettings_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update EyesOn settings.": { + "$ref": "./examples/settings/UpdateEyesOnSetting.json" + } + }, + "tags": [ + "Settings" + ], + "description": "Updates setting.", + "operationId": "ProductSettings_Update", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SettingsName" + }, + { + "$ref": "#/parameters/Settings" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Settings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "SettingList": { + "description": "List of all the settings.", + "properties": { + "value": { + "description": "Array of settings.", + "items": { + "$ref": "#/definitions/Settings" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "Settings": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "The Setting.", + "properties": { + "kind": { + "description": "The kind of the setting", + "enum": [ + "Anomalies", + "EyesOn", + "EntityAnalytics", + "Ueba" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SettingKind" + } + } + }, + "required": [ + "kind" + ], + "discriminator": "kind", + "type": "object" + }, + "Anomalies": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/AnomaliesSettingsProperties", + "description": "Anomalies properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Anomalies" + }, + "AnomaliesSettingsProperties": { + "description": "Anomalies property bag.", + "properties": { + "isEnabled": { + "description": "Determines whether the setting is enable or disabled.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "EyesOn": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/EyesOnSettingsProperties", + "description": "EyesOn properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "EyesOn" + }, + "EyesOnSettingsProperties": { + "description": "EyesOn property bag.", + "properties": { + "isEnabled": { + "description": "Determines whether the setting is enable or disabled.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "EntityAnalytics": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/EntityAnalyticsProperties", + "description": "EntityAnalytics properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "EntityAnalytics" + }, + "EntityAnalyticsProperties": { + "description": "EntityAnalytics property bag.", + "properties": { + "entityProviders": { + "description": "The relevant entity providers that are synced", + "items": { + "$ref": "#/definitions/EntityProviders" + }, + "type": "array" + } + }, + "type": "object" + }, + "EntityProviders": { + "description": "The entity provider that is synced.", + "enum": [ + "ActiveDirectory", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityProviders" + } + }, + "Ueba": { + "allOf": [ + { + "$ref": "#/definitions/Settings" + } + ], + "description": "Settings with single toggle.", + "properties": { + "properties": { + "$ref": "#/definitions/UebaProperties", + "description": "Ueba properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Ueba" + }, + "UebaProperties": { + "description": "Ueba property bag.", + "properties": { + "dataSources": { + "description": "The relevant data sources that enriched by ueba", + "items": { + "$ref": "#/definitions/UebaDataSources" + }, + "type": "array" + } + }, + "type": "object" + }, + "UebaDataSources": { + "description": "The data source that enriched by ueba.", + "enum": [ + "AuditLogs", + "AzureActivity", + "SecurityEvent", + "SigninLogs" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "UebaDataSources" + } + } + }, + "parameters": { + "Settings": { + "description": "The setting", + "in": "body", + "name": "settings", + "required": true, + "schema": { + "$ref": "#/definitions/Settings" + }, + "x-ms-parameter-location": "method" + }, + "SettingsName": { + "description": "The setting name. Supports - Anomalies, EyesOn, EntityAnalytics, Ueba", + "in": "path", + "name": "settingsName", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/SourceControls.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/SourceControls.json new file mode 100644 index 000000000000..33bfab3bbf9e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/SourceControls.json @@ -0,0 +1,735 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/listRepositories": { + "post": { + "x-ms-examples": { + "Get repository list.": { + "$ref": "./examples/repositories/GetRepositories.json" + } + }, + "tags": [ + "Repositories" + ], + "description": "Gets a list of repositories metadata.", + "operationId": "SourceControl_listRepositories", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RepoTypeParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RepoList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols": { + "get": { + "x-ms-examples": { + "Get all source controls.": { + "$ref": "./examples/sourcecontrols/GetSourceControls.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Gets all source controls, without source control items.", + "operationId": "SourceControls_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControlList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/sourcecontrols/{sourceControlId}": { + "get": { + "x-ms-examples": { + "Get a source control.": { + "$ref": "./examples/sourcecontrols/GetSourceControlById.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Gets a source control byt its identifier.", + "operationId": "SourceControls_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SourceControlIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a source control.": { + "$ref": "./examples/sourcecontrols/DeleteSourceControl.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Delete a source control.", + "operationId": "SourceControls_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SourceControlIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates a source control.": { + "$ref": "./examples/sourcecontrols/CreateSourceControl.json" + } + }, + "tags": [ + "SourceControls" + ], + "description": "Creates a source control.", + "operationId": "SourceControls_Create", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/SourceControlIdParameter" + }, + { + "$ref": "#/parameters/SourceControl" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SourceControl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "RepoList": { + "description": "List all the source controls.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of repositories.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of repositories.", + "items": { + "$ref": "#/definitions/Repo" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "Repo": { + "description": "Represents a repository.", + "properties": { + "url": { + "description": "The url to access the repository.", + "type": "string" + }, + "fullName": { + "description": "The name of the repository.", + "type": "string" + }, + "branches": { + "description": "Array of branches.", + "items": { + "description": "name of branch.", + "type": "string" + }, + "type": "array" + } + }, + "x-ms-azure-resource": false, + "type": "object" + }, + "SourceControlList": { + "description": "List all the source controls.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of source controls.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of source controls.", + "items": { + "$ref": "#/definitions/SourceControl" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "SourceControl": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a SourceControl in Azure Security Insights.", + "properties": { + "properties": { + "description": "source control properties", + "$ref": "#/definitions/SourceControlProperties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "SourceControlProperties": { + "description": "Describes source control properties", + "properties": { + "id": { + "description": "The id (a Guid) of the source control", + "type": "string" + }, + "version": { + "$ref": "#/definitions/Version", + "description": "The version number associated with the source control", + "type": "string" + }, + "displayName": { + "description": "The display name of the source control", + "type": "string" + }, + "description": { + "description": "A description of the source control", + "type": "string" + }, + "repoType": { + "$ref": "#/definitions/RepoType", + "description": "The repository type of the source control", + "type": "string" + }, + "contentTypes": { + "description": "Array of source control content types.", + "items": { + "$ref": "#/definitions/ContentType" + }, + "type": "array" + }, + "repository": { + "description": "Repository metadata.", + "$ref": "#/definitions/Repository" + }, + "repositoryResourceInfo": { + "description": "Information regarding the resources created in user's repository.", + "$ref": "#/definitions/RepositoryResourceInfo" + }, + "lastDeploymentInfo": { + "description": "Information regarding the latest deployment for the source control.", + "$ref": "#/definitions/DeploymentInfo" + } + }, + "required": [ + "displayName", + "repoType", + "contentTypes", + "repository" + ], + "type": "object" + }, + "Repository": { + "type": "object", + "description": "metadata of a repository.", + "properties": { + "url": { + "description": "Url of repository.", + "type": "string" + }, + "branch": { + "description": "Branch name of repository.", + "type": "string" + }, + "displayUrl": { + "description": "Display url of repository.", + "type": "string" + }, + "deploymentLogsUrl": { + "description": "Url to access repository action logs.", + "type": "string" + }, + "pathMapping": { + "description": "Dictionary of source control content type and path mapping.", + "items": { + "$ref": "#/definitions/ContentPathMap" + }, + "type": "array", + "x-ms-identifiers": [] + } + } + }, + "RepositoryResourceInfo": { + "type": "object", + "description": "Resources created in user's repository for the source-control.", + "properties": { + "webhook": { + "type": "object", + "description": "The webhook object created for the source-control.", + "$ref": "#/definitions/Webhook" + }, + "gitHubResourceInfo": { + "type": "object", + "description": "Resources created in GitHub for this source-control.", + "$ref": "#/definitions/GitHubResourceInfo" + }, + "azureDevOpsResourceInfo": { + "type": "object", + "description": "Resources created in Azure DevOps for this source-control.", + "$ref": "#/definitions/AzureDevOpsResourceInfo" + } + } + }, + "Webhook": { + "description": "Detail about the webhook object.", + "type": "object", + "properties": { + "webhookId": { + "description": "Unique identifier for the webhook.", + "type": "string" + }, + "webhookUrl": { + "description": "URL that gets invoked by the webhook.", + "type": "string" + }, + "webhookSecretUpdateTime": { + "description": "Time when the webhook secret was updated.", + "type": "string" + }, + "rotateWebhookSecret": { + "description": "A flag to instruct the backend service to rotate webhook secret.", + "type": "boolean" + } + } + }, + "GitHubResourceInfo": { + "description": "Resources created in GitHub repository.", + "type": "object", + "properties": { + "appInstallationId": { + "description": "GitHub application installation id.", + "type": "string" + } + } + }, + "AzureDevOpsResourceInfo": { + "description": "Resources created in Azure DevOps repository.", + "type": "object", + "properties": { + "pipelineId": { + "description": "Id of the pipeline created for the source-control.", + "type": "string" + }, + "serviceConnectionId": { + "description": "Id of the service-connection created for the source-control.", + "type": "string" + } + } + }, + "DeploymentInfo": { + "description": "Information regarding a deployment.", + "type": "object", + "properties": { + "deploymentFetchStatus": { + "$ref": "#/definitions/DeploymentFetchStatus", + "description": "Status while fetching the last deployment.", + "type": "string" + }, + "deployment": { + "$ref": "#/definitions/Deployment", + "description": "Deployment information.", + "type": "object" + }, + "message": { + "description": "Additional details about the deployment that can be shown to the user.", + "type": "string" + } + } + }, + "Deployment": { + "description": "Description about a deployment.", + "type": "object", + "properties": { + "deploymentId": { + "description": "Deployment identifier.", + "type": "string" + }, + "deploymentState": { + "$ref": "#/definitions/DeploymentState", + "description": "Current status of the deployment.", + "type": "string" + }, + "deploymentResult": { + "$ref": "#/definitions/DeploymentResult", + "description": "The outcome of the deployment.", + "type": "string" + }, + "deploymentTime": { + "format": "date-time", + "description": "The time when the deployment finished.", + "type": "string" + }, + "deploymentLogsUrl": { + "description": "Url to access repository action logs.", + "type": "string" + } + } + }, + "ContentPathMap": { + "description": "The mapping of content type to a repo path.", + "properties": { + "contentType": { + "$ref": "#/definitions/ContentType", + "description": "Content type.", + "type": "string" + }, + "path": { + "description": "The path to the content.", + "type": "string" + } + }, + "type": "object" + }, + "ContentType": { + "description": "The content type of a source control path.", + "enum": [ + "AnalyticRule", + "Workbook" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ContentType", + "values": [ + { + "value": "AnalyticRule" + }, + { + "value": "Workbook" + } + ] + } + }, + "RepoType": { + "description": "The type of repository.", + "enum": [ + "Github", + "DevOps" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RepoType", + "values": [ + { + "value": "Github" + }, + { + "value": "DevOps" + } + ] + } + }, + "Version": { + "description": "The version of the source control.", + "enum": [ + "V1", + "V2" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "Version", + "values": [ + { + "value": "V1" + }, + { + "value": "V2" + } + ] + } + }, + "DeploymentFetchStatus": { + "description": "Status while trying to fetch the deployment information.", + "enum": [ + "Success", + "Unauthorized", + "NotFound" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeploymentFetchStatus", + "values": [ + { + "value": "Success" + }, + { + "value": "Unauthorized" + }, + { + "value": "NotFound" + } + ] + } + }, + "DeploymentState": { + "description": "The current state of the deployment.", + "enum": [ + "In_Progress", + "Completed", + "Queued", + "Canceling" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeploymentState", + "values": [ + { + "value": "In_Progress" + }, + { + "value": "Completed" + }, + { + "value": "Queued" + }, + { + "value": "Canceling" + } + ] + } + }, + "DeploymentResult": { + "description": "Status while trying to fetch the deployment information.", + "enum": [ + "Success", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeploymentResult", + "values": [ + { + "value": "Success" + }, + { + "value": "Canceled" + }, + { + "value": "Failed" + } + ] + } + } + }, + "parameters": { + "RepoTypeParameter": { + "description": "The repo type.", + "in": "body", + "name": "repoType", + "required": true, + "schema": { + "$ref": "#/definitions/RepoType" + }, + "x-ms-parameter-location": "method" + }, + "SourceControlIdParameter": { + "description": "Source control Id", + "in": "path", + "name": "sourceControlId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SourceControl": { + "description": "The SourceControl", + "in": "body", + "name": "sourceControl", + "required": true, + "schema": { + "$ref": "#/definitions/SourceControl" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ThreatIntelligence.json new file mode 100644 index 000000000000..30b17e324416 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/ThreatIntelligence.json @@ -0,0 +1,1097 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/createIndicator": { + "post": { + "x-ms-examples": { + "Create a new Threat Intelligence": { + "$ref": "./examples/threatintelligence/CreateThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Create a new threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_CreateIndicator", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to create indicators.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators": { + "get": { + "x-ms-examples": { + "Get all threat intelligence indicators": { + "$ref": "./examples/threatintelligence/GetThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Get all threat intelligence indicators.", + "operationId": "ThreatIntelligenceIndicators_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataFilter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed to get indicators.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}": { + "get": { + "x-ms-examples": { + "View a threat intelligence indicator by name": { + "$ref": "./examples/threatintelligence/GetThreatIntelligenceById.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "View a threat intelligence indicator by name.", + "operationId": "ThreatIntelligenceIndicator_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to view an indicator.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Update a threat Intelligence indicator": { + "$ref": "./examples/threatintelligence/UpdateThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Update a threat Intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_Create", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceProperties" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to update an indicator.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a threat intelligence indicator": { + "$ref": "./examples/threatintelligence/DeleteThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Delete a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed to delete an indicator.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/queryIndicators": { + "post": { + "x-ms-examples": { + "Query threat intelligence indicators as per filtering criteria": { + "$ref": "./examples/threatintelligence/QueryThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Query threat intelligence indicators as per filtering criteria.", + "operationId": "ThreatIntelligenceIndicator_QueryIndicators", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceFilteringCriteria" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/metrics": { + "get": { + "x-ms-examples": { + "Get threat intelligence indicators metrics.": { + "$ref": "./examples/threatintelligence/CollectThreatIntelligenceMetrics.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Get threat intelligence indicators metrics (Indicators counts by Type, Threat Type, Source).", + "operationId": "ThreatIntelligenceIndicatorMetrics_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceMetricsList" + } + }, + "default": { + "description": "Error response describing why the operation failed to get metrics.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/appendTags": { + "post": { + "x-ms-examples": { + "Append tags to a threat intelligence indicator": { + "$ref": "./examples/threatintelligence/AppendTagsThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Append tags to a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_AppendTags", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceAppendTags" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed to append tags.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/threatIntelligence/main/indicators/{name}/replaceTags": { + "post": { + "x-ms-examples": { + "Replace tags to a Threat Intelligence": { + "$ref": "./examples/threatintelligence/ReplaceTagsThreatIntelligence.json" + } + }, + "tags": [ + "ThreatIntelligence" + ], + "description": "Replace tags added to a threat intelligence indicator.", + "operationId": "ThreatIntelligenceIndicator_ReplaceTags", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceName" + }, + { + "$ref": "#/parameters/ThreatIntelligenceReplaceTags" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed to replace tags.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "parameters": { + "ThreatIntelligenceName": { + "description": "Threat intelligence indicator name field.", + "in": "path", + "name": "name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceProperties": { + "description": "Properties of threat intelligence indicators to create and update.", + "in": "body", + "name": "ThreatIntelligenceProperties", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorModel" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceReplaceTags": { + "description": "Tags in the threat intelligence indicator to be replaced.", + "in": "body", + "name": "ThreatIntelligenceReplaceTags", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorModel" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceFilteringCriteria": { + "description": "Filtering criteria for querying threat intelligence indicators.", + "in": "body", + "name": "ThreatIntelligenceFilteringCriteria", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceFilteringCriteria" + }, + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceIndicatorEntityKind": { + "description": "The threat intelligence entity kind", + "in": "query", + "name": "ctiEntityKind", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ThreatIntelligenceAppendTags": { + "description": "The threat intelligence append tags request body", + "in": "body", + "name": "ThreatIntelligenceAppendTags", + "required": true, + "schema": { + "$ref": "#/definitions/ThreatIntelligenceAppendTags" + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ThreatIntelligenceInformationList": { + "description": "List of all the threat intelligence information objects.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of information objects.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of threat intelligence information objects.", + "items": { + "$ref": "#/definitions/ThreatIntelligenceInformation" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "ThreatIntelligenceInformation": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Threat intelligence information object.", + "properties": { + "kind": { + "$ref": "#/definitions/ThreatIntelligenceResourceInnerKind", + "description": "The kind of the entity." + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "ThreatIntelligenceIndicatorModel": { + "allOf": [ + { + "$ref": "#/definitions/ThreatIntelligenceInformation" + } + ], + "description": "Threat intelligence indicator entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ThreatIntelligenceIndicatorProperties", + "description": "Threat Intelligence Entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "indicator" + }, + "ThreatIntelligenceResourceInnerKind": { + "description": "The kind of the threat intelligence entity", + "enum": [ + "indicator" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ThreatIntelligenceResourceInnerKind", + "values": [ + { + "description": "Entity represents threat intelligence indicator in the system.", + "value": "indicator" + } + ] + } + }, + "ThreatIntelligenceIndicatorProperties": { + "allOf": [ + { + "$ref": "./common/EntityTypes.json#/definitions/EntityCommonProperties" + } + ], + "description": "Describes threat intelligence entity properties", + "properties": { + "threatIntelligenceTags": { + "description": "List of tags", + "items": { + "description": "tag", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "lastUpdatedTimeUtc": { + "description": "Last updated time in UTC", + "type": "string" + }, + "source": { + "description": "Source of a threat intelligence entity", + "type": "string" + }, + "displayName": { + "description": "Display name of a threat intelligence entity", + "type": "string" + }, + "description": { + "description": "Description of a threat intelligence entity", + "type": "string" + }, + "indicatorTypes": { + "description": "Indicator types of threat intelligence entities", + "items": { + "description": "Indicator type of a threat intelligence entity", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "pattern": { + "description": "Pattern of a threat intelligence entity", + "type": "string" + }, + "patternType": { + "description": "Pattern type of a threat intelligence entity", + "type": "string" + }, + "patternVersion": { + "description": "Pattern version of a threat intelligence entity", + "type": "string" + }, + "killChainPhases": { + "description": "Kill chain phases", + "items": { + "description": "Kill chain phase", + "$ref": "#/definitions/ThreatIntelligenceKillChainPhase" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "parsedPattern": { + "description": "Parsed patterns", + "items": { + "description": "Parsed pattern", + "$ref": "#/definitions/ThreatIntelligenceParsedPattern" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "externalId": { + "description": "External ID of threat intelligence entity", + "type": "string" + }, + "createdByRef": { + "description": "Created by reference of threat intelligence entity", + "type": "string" + }, + "defanged": { + "description": "Is threat intelligence entity defanged", + "type": "boolean" + }, + "externalLastUpdatedTimeUtc": { + "description": "External last updated time in UTC", + "type": "string" + }, + "externalReferences": { + "description": "External References", + "items": { + "description": "external_reference", + "$ref": "#/definitions/ThreatIntelligenceExternalReference" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "granularMarkings": { + "description": "Granular Markings", + "items": { + "description": "Granular marking", + "$ref": "#/definitions/ThreatIntelligenceGranularMarkingModel" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "labels": { + "description": "Labels of threat intelligence entity", + "items": { + "description": "label", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "revoked": { + "description": "Is threat intelligence entity revoked", + "type": "boolean" + }, + "confidence": { + "description": "Confidence of threat intelligence entity", + "type": "integer", + "format": "int32" + }, + "objectMarkingRefs": { + "description": "Threat intelligence entity object marking references", + "items": { + "description": "Threat intelligence entity object marking reference", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "language": { + "description": "Language of threat intelligence entity", + "type": "string" + }, + "threatTypes": { + "description": "Threat types", + "items": { + "description": "Threat type", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "validFrom": { + "description": "Valid from", + "type": "string" + }, + "validUntil": { + "description": "Valid until", + "type": "string" + }, + "created": { + "description": "Created by", + "type": "string" + }, + "modified": { + "description": "Modified by", + "type": "string" + }, + "extensions": { + "description": "Extensions map", + "type": "object", + "additionalProperties": {} + } + }, + "type": "object" + }, + "ThreatIntelligenceKillChainPhase": { + "description": "Describes threat kill chain phase entity", + "properties": { + "killChainName": { + "description": "Kill chainName name", + "type": "string" + }, + "phaseName": { + "description": "Phase name", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceParsedPattern": { + "description": "Describes parsed pattern entity", + "properties": { + "patternTypeKey": { + "description": "Pattern type key", + "type": "string" + }, + "patternTypeValues": { + "description": "Pattern type keys", + "items": { + "description": "Pattern type key", + "$ref": "#/definitions/ThreatIntelligenceParsedPatternTypeValue" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "ThreatIntelligenceParsedPatternTypeValue": { + "description": "Describes threat kill chain phase entity", + "properties": { + "valueType": { + "description": "Type of the value", + "type": "string" + }, + "value": { + "description": "Value of parsed pattern", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceGranularMarkingModel": { + "description": "Describes threat granular marking model entity", + "properties": { + "language": { + "description": "Language granular marking model", + "type": "string" + }, + "markingRef": { + "description": "marking reference granular marking model", + "type": "integer", + "format": "int32" + }, + "selectors": { + "description": "granular marking model selectors", + "items": { + "description": "granular marking model selector", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "ThreatIntelligenceExternalReference": { + "description": "Describes external reference", + "properties": { + "description": { + "description": "External reference description", + "type": "string" + }, + "externalId": { + "description": "External reference ID", + "type": "string" + }, + "sourceName": { + "description": "External reference source name", + "type": "string" + }, + "url": { + "description": "External reference URL", + "type": "string" + }, + "hashes": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "External reference hashes" + } + }, + "type": "object" + }, + "ThreatIntelligenceFilteringCriteria": { + "description": "Filtering criteria for querying threat intelligence indicators.", + "properties": { + "pageSize": { + "description": "Page size", + "type": "integer", + "format": "int32" + }, + "minConfidence": { + "description": "Minimum confidence.", + "type": "integer", + "format": "int32" + }, + "maxConfidence": { + "description": "Maximum confidence.", + "type": "integer", + "format": "int32" + }, + "minValidUntil": { + "description": "Start time for ValidUntil filter.", + "type": "string" + }, + "maxValidUntil": { + "description": "End time for ValidUntil filter.", + "type": "string" + }, + "includeDisabled": { + "description": "Parameter to include/exclude disabled indicators.", + "type": "boolean" + }, + "sortBy": { + "description": "Columns to sort by and sorting order", + "items": { + "description": "Sort By", + "$ref": "#/definitions/ThreatIntelligenceSortingCriteria" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "sources": { + "description": "Sources of threat intelligence indicators", + "items": { + "description": "Source", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "patternTypes": { + "description": "Pattern types", + "items": { + "description": "Pattern type", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "threatTypes": { + "description": "Threat types of threat intelligence indicators", + "items": { + "description": "Threat type of a threat intelligence indicator", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "ids": { + "description": "Ids of threat intelligence indicators", + "items": { + "description": "Id of a threat intelligence indicator", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "keywords": { + "description": "Keywords for searching threat intelligence indicators", + "items": { + "description": "keyword for searching threat intelligence indicators", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "skipToken": { + "description": "Skip token.", + "type": "string" + } + }, + "type": "object" + }, + "ThreatIntelligenceSortingCriteria": { + "description": "List of available columns for sorting", + "properties": { + "itemKey": { + "description": "Column name", + "type": "string" + }, + "sortOrder": { + "$ref": "#/definitions/ThreatIntelligenceSortingOrder", + "description": "Sorting order (ascending/descending/unsorted)." + } + }, + "type": "object" + }, + "ThreatIntelligenceSortingOrder": { + "description": "Sorting order (ascending/descending/unsorted).", + "enum": [ + "unsorted", + "ascending", + "descending" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ThreatIntelligenceSortingOrder", + "values": [ + { + "value": "unsorted" + }, + { + "value": "ascending" + }, + { + "value": "descending" + } + ] + } + }, + "ThreatIntelligenceAppendTags": { + "description": "Array of tags to be appended to the threat intelligence indicator.", + "properties": { + "threatIntelligenceTags": { + "description": "List of tags to be appended.", + "items": { + "description": "parameter", + "type": "string" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "ThreatIntelligenceMetricsList": { + "description": "List of all the threat intelligence metric fields (type/threat type/source).", + "properties": { + "value": { + "description": "Array of threat intelligence metric fields (type/threat type/source).", + "items": { + "$ref": "#/definitions/ThreatIntelligenceMetrics" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "ThreatIntelligenceMetrics": { + "description": "Threat intelligence metrics.", + "properties": { + "properties": { + "description": "Threat intelligence metrics.", + "$ref": "#/definitions/ThreatIntelligenceMetric" + } + }, + "type": "object" + }, + "ThreatIntelligenceMetric": { + "description": "Describes threat intelligence metric", + "properties": { + "lastUpdatedTimeUtc": { + "description": "Last updated indicator metric", + "type": "string" + }, + "threatTypeMetrics": { + "description": "Threat type metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "patternTypeMetrics": { + "description": "Pattern type metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "sourceMetrics": { + "description": "Source metrics", + "items": { + "description": "parameter", + "$ref": "#/definitions/ThreatIntelligenceMetricEntity" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "ThreatIntelligenceMetricEntity": { + "description": "Describes threat intelligence metric entity", + "properties": { + "metricName": { + "description": "Metric name", + "type": "string" + }, + "metricValue": { + "description": "Metric value", + "type": "integer", + "format": "int32" + } + }, + "type": "object" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/TriggeredAnalyticsRuleRuns.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/TriggeredAnalyticsRuleRuns.json new file mode 100644 index 000000000000..885e40100fa3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/TriggeredAnalyticsRuleRuns.json @@ -0,0 +1,353 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-05-01-preview" + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns/{ruleRunId}": { + "get": { + "tags": [ + "triggered analytics rule run" + ], + "description": "Gets the triggered analytics rule run.", + "operationId": "triggeredAnalyticsRuleRun_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "description": "the triggered rule id", + "in": "path", + "name": "ruleRunId", + "required": true, + "type": "string" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TriggeredAnalyticsRuleRun" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "triggeredAnalyticsRuleRun_Get": { + "$ref": "./examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns": { + "get": { + "tags": [ + "triggered analytics rule runs" + ], + "description": "Gets the triggered analytics rule runs.", + "operationId": "getTriggeredAnalyticsRuleRuns_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TriggeredAnalyticsRuleRuns" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "triggeredAnalyticsRuleRuns_Get": { + "$ref": "./examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRules/{ruleId}/triggerRuleRun": { + "post": { + "tags": [ + "trigger analytics rule run" + ], + "description": "triggers analytics rule run", + "operationId": "alertRule_TriggerRuleRun", + "produces": [ + "application/json" + ], + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/RuleId" + }, + { + "$ref": "#/parameters/AnalyticsRuleRunTriggerParameter" + } + ], + "responses": { + "202": { + "description": "The analytics rule run was successfully triggered.", + "headers": { + "Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "triggerRuleRun_Post": { + "$ref": "./examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ProvisioningState": { + "enum": [ + "Accepted", + "InProgress", + "Succeeded", + "Failed", + "Canceled" + ], + "description": "The triggered analytics rule run provisioning state", + "type": "string", + "example": "Accepted", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Accepted" + }, + { + "value": "InProgress" + }, + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Canceled" + } + ] + } + }, + "TriggeredAnalyticsRuleRun": { + "required": [ + "properties" + ], + "description": "The triggered analytics rule run", + "type": "object", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TriggeredAnalyticsRuleRunProperties", + "x-ms-client-flatten": true + } + } + }, + "TriggeredAnalyticsRuleRunProperties": { + "required": [ + "executionTimeUtc", + "provisioningState", + "ruleId", + "triggeredAnalyticsRuleRunId" + ], + "description": "The triggered analytics rule run Properties", + "type": "object", + "properties": { + "executionTimeUtc": { + "format": "date-time", + "type": "string" + }, + "ruleId": { + "type": "string" + }, + "triggeredAnalyticsRuleRunId": { + "type": "string" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "ruleRunAdditionalData": { + "type": "object", + "additionalProperties": {} + } + } + }, + "TriggeredAnalyticsRuleRuns": { + "required": [ + "value" + ], + "description": "The triggered analytics rule run array", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TriggeredAnalyticsRuleRun" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "AnalyticsRuleRunTriggerProperties": { + "required": [ + "executionTimeUtc" + ], + "description": "The Analytics Rule Run Trigger properties", + "type": "object", + "properties": { + "executionTimeUtc": { + "format": "date-time", + "type": "string" + } + } + }, + "AnalyticsRuleRunTrigger": { + "required": [ + "properties" + ], + "description": "Analytics Rule Run Trigger request", + "properties": { + "properties": { + "$ref": "#/definitions/AnalyticsRuleRunTriggerProperties", + "description": "The analytics Rule Run Trigger request", + "x-ms-client-flatten": true + } + }, + "type": "object" + } + }, + "parameters": { + "RuleId": { + "description": "Alert rule ID", + "in": "path", + "name": "ruleId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AnalyticsRuleRunTriggerParameter": { + "description": "The Analytics Rule Run Trigger parameter", + "in": "body", + "name": "analyticsRuleRunTriggerParameter", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyticsRuleRunTrigger" + }, + "x-ms-parameter-location": "method" + } + }, + "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" + ] + } + ], + "tags": [ + { + "name": "AnalyticsOnDemandArm", + "description": "Controller that handles requests for triggeredAnalyticsRuleRuns ARM API." + }, + { + "name": "AnalyticsOnDemandArm", + "description": "Triggered Analytics Rule Runs" + } + ], + "host": "management.azure.com", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Watchlists.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Watchlists.json new file mode 100644 index 000000000000..98c36171ab67 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/Watchlists.json @@ -0,0 +1,721 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists": { + "get": { + "x-ms-examples": { + "Get all watchlists.": { + "$ref": "./examples/watchlists/GetWatchlists.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Gets all watchlists, without watchlist items.", + "operationId": "Watchlists_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}": { + "get": { + "x-ms-examples": { + "Get a watchlist.": { + "$ref": "./examples/watchlists/GetWatchlistByAlias.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Gets a watchlist, without its watchlist items.", + "operationId": "Watchlists_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Watchlist" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a watchlist.": { + "$ref": "./examples/watchlists/DeleteWatchlist.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Delete a watchlist.", + "operationId": "Watchlists_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "Azure-AsyncOperation": { + "description": "Contains the status URL on which clients are expected to poll the status of the delete operation.", + "type": "string" + } + } + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a watchlist.": { + "$ref": "./examples/watchlists/CreateWatchlist.json" + }, + "Creates or updates a watchlist and bulk creates watchlist items.": { + "$ref": "./examples/watchlists/CreateWatchlistAndWatchlistItems.json" + } + }, + "tags": [ + "Watchlists" + ], + "description": "Create or update a Watchlist and its Watchlist Items (bulk creation, e.g. through text/csv content type). To create a Watchlist and its Items, we should call this endpoint with either rawContent or a valid SAR URI and contentType properties. The rawContent is mainly used for small watchlist (content size below 3.8 MB). The SAS URI enables the creation of large watchlist, where the content size can go up to 500 MB. The status of processing such large file can be polled through the URL returned in Azure-AsyncOperation header.", + "operationId": "Watchlists_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/Watchlist" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Watchlist" + } + }, + "201": { + "description": "Created. The response includes the Provisioning State and the Azure-AsyncOperation header. To get the progress of the operation, call GET operation on the URL in Azure-AsyncOperation header field.", + "schema": { + "$ref": "#/definitions/Watchlist" + }, + "headers": { + "Azure-AsyncOperation": { + "description": "Contains the status URL on which clients are expected to poll the status of the operation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems": { + "get": { + "x-ms-examples": { + "Get all watchlist Items.": { + "$ref": "./examples/watchlists/GetWatchlistItems.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Gets all watchlist Items.", + "operationId": "WatchlistItems_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + }, + { + "$ref": "#/parameters/WatchlistAlias" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistItemList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/watchlists/{watchlistAlias}/watchlistItems/{watchlistItemId}": { + "get": { + "x-ms-examples": { + "Get a watchlist item.": { + "$ref": "./examples/watchlists/GetWatchlistItemById.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Gets a watchlist, without its watchlist items.", + "operationId": "WatchlistItems_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a watchlist Item.": { + "$ref": "./examples/watchlists/DeleteWatchlistItem.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Delete a watchlist item.", + "operationId": "WatchlistItems_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a watchlist item.": { + "$ref": "./examples/watchlists/CreateWatchlistItem.json" + } + }, + "tags": [ + "WatchlistItems" + ], + "description": "Creates or updates a watchlist item.", + "operationId": "WatchlistItems_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WatchlistAlias" + }, + { + "$ref": "#/parameters/WatchlistItemId" + }, + { + "$ref": "#/parameters/WatchlistItem" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WatchlistItem" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WatchlistItem" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "WatchlistList": { + "description": "List all the watchlists.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of watchlists.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of watchlist.", + "items": { + "$ref": "#/definitions/Watchlist" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "Watchlist": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Watchlist in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/WatchlistProperties", + "description": "Watchlist properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WatchlistProperties": { + "description": "Describes watchlist properties", + "properties": { + "watchlistId": { + "description": "The id (a Guid) of the watchlist", + "type": "string" + }, + "displayName": { + "description": "The display name of the watchlist", + "type": "string" + }, + "provider": { + "description": "The provider of the watchlist", + "type": "string" + }, + "source": { + "description": "The filename of the watchlist, called 'source'", + "type": "string" + }, + "sourceType": { + "description": "The sourceType of the watchlist", + "enum": [ + "Local file", + "Remote storage" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "sourceType" + } + }, + "created": { + "description": "The time the watchlist was created", + "format": "date-time", + "type": "string" + }, + "updated": { + "description": "The last time the watchlist was updated", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that created the watchlist", + "type": "object" + }, + "updatedBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that updated the watchlist", + "type": "object" + }, + "description": { + "description": "A description of the watchlist", + "type": "string" + }, + "watchlistType": { + "description": "The type of the watchlist", + "type": "string" + }, + "watchlistAlias": { + "description": "The alias of the watchlist", + "type": "string" + }, + "isDeleted": { + "description": "A flag that indicates if the watchlist is deleted or not", + "type": "boolean" + }, + "labels": { + "description": "List of labels relevant to this watchlist", + "items": { + "$ref": "../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array" + }, + "defaultDuration": { + "description": "The default duration of a watchlist (in ISO 8601 duration format)", + "format": "duration", + "type": "string" + }, + "tenantId": { + "description": "The tenantId where the watchlist belongs to", + "type": "string" + }, + "numberOfLinesToSkip": { + "description": "The number of lines in a csv/tsv content to skip before the header", + "type": "integer", + "format": "int32" + }, + "rawContent": { + "description": "The raw content that represents to watchlist items to create. In case of csv/tsv content type, it's the content of the file that will parsed by the endpoint", + "type": "string" + }, + "itemsSearchKey": { + "description": "The search key is used to optimize query performance when using watchlists for joins with other data. For example, enable a column with IP addresses to be the designated SearchKey field, then use this field as the key field when joining to other event data by IP address.", + "type": "string" + }, + "contentType": { + "description": "The content type of the raw content. Example : text/csv or text/tsv ", + "type": "string" + }, + "uploadStatus": { + "description": "The status of the Watchlist upload : New, InProgress or Complete. Pls note : When a Watchlist upload status is equal to InProgress, the Watchlist cannot be deleted", + "type": "string" + } + }, + "required": [ + "displayName", + "provider", + "itemsSearchKey" + ], + "type": "object" + }, + "WatchlistItemList": { + "description": "List all the watchlist items.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of watchlist item.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of watchlist items.", + "items": { + "$ref": "#/definitions/WatchlistItem" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "WatchlistItem": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "Represents a Watchlist item in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/WatchlistItemProperties", + "description": "Watchlist Item properties", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WatchlistItemProperties": { + "description": "Describes watchlist item properties", + "properties": { + "watchlistItemType": { + "description": "The type of the watchlist item", + "type": "string" + }, + "watchlistItemId": { + "description": "The id (a Guid) of the watchlist item", + "type": "string" + }, + "tenantId": { + "description": "The tenantId to which the watchlist item belongs to", + "type": "string" + }, + "isDeleted": { + "description": "A flag that indicates if the watchlist item is deleted or not", + "type": "boolean" + }, + "created": { + "description": "The time the watchlist item was created", + "format": "date-time", + "type": "string" + }, + "updated": { + "description": "The last time the watchlist item was updated", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that created the watchlist item", + "type": "object" + }, + "updatedBy": { + "$ref": "../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that updated the watchlist item" + }, + "itemsKeyValue": { + "description": "key-value pairs for a watchlist item", + "type": "object", + "additionalProperties": {} + }, + "entityMapping": { + "description": "key-value pairs for a watchlist item entity mapping", + "type": "object", + "additionalProperties": {} + } + }, + "required": [ + "itemsKeyValue" + ], + "type": "object" + } + }, + "parameters": { + "WatchlistAlias": { + "description": "Watchlist Alias", + "in": "path", + "name": "watchlistAlias", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "Watchlist": { + "description": "The watchlist", + "in": "body", + "name": "watchlist", + "required": true, + "schema": { + "$ref": "#/definitions/Watchlist" + }, + "x-ms-parameter-location": "method" + }, + "WatchlistItem": { + "description": "The watchlist item", + "in": "body", + "name": "watchlistItem", + "required": true, + "schema": { + "$ref": "#/definitions/WatchlistItem" + }, + "x-ms-parameter-location": "method" + }, + "WatchlistItemId": { + "description": "Watchlist Item Id (GUID)", + "in": "path", + "name": "watchlistItemId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerAssignments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerAssignments.json new file mode 100644 index 000000000000..7a64237f5a7c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerAssignments.json @@ -0,0 +1,737 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerAssignments": { + "get": { + "x-ms-examples": { + "Get all workspace manager assignments for the Sentinel workspace manager.": { + "$ref": "./examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Get all workspace manager assignments for the Sentinel workspace manager.", + "operationId": "WorkspaceManagerAssignments_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/{workspaceManagerAssignmentName}": { + "get": { + "x-ms-examples": { + "Get a workspace manager assignment": { + "$ref": "./examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Gets a workspace manager assignment", + "operationId": "WorkspaceManagerAssignments_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a workspace manager assignment.": { + "$ref": "./examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Creates or updates a workspace manager assignment.", + "operationId": "WorkspaceManagerAssignments_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignment" + } + ], + "responses": { + "200": { + "description": "OK, created or updated an instance", + "schema": { + "$ref": "#/definitions/WorkspaceManagerAssignment" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WorkspaceManagerAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace manager assignment.": { + "$ref": "./examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Deletes a workspace manager assignment", + "operationId": "WorkspaceManagerAssignments_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/{workspaceManagerAssignmentName}/jobs": { + "get": { + "x-ms-examples": { + "Get all jobs for the specified Sentinel workspace manager assignment.": { + "$ref": "./examples/workspaceManagerAssignments/GetAllJobs.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Get all jobs for the specified workspace manager assignment", + "operationId": "WorkspaceManagerAssignmentJobs_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + }, + "post": { + "x-ms-examples": { + "Creates a job for the specified workspace manager assignment": { + "$ref": "./examples/workspaceManagerAssignments/CreateJob.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Create a job for the specified workspace manager assignment", + "operationId": "WorkspaceManagerAssignmentJobs_Create", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + } + ], + "responses": { + "200": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/{workspaceManagerAssignmentName}/jobs/{jobName}": { + "get": { + "x-ms-examples": { + "Get a workspace manager job": { + "$ref": "./examples/workspaceManagerAssignments/GetJob.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Gets a job", + "operationId": "WorkspaceManagerAssignmentJobs_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + }, + { + "$ref": "#/parameters/JobName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace manager job.": { + "$ref": "./examples/workspaceManagerAssignments/DeleteJob.json" + } + }, + "tags": [ + "workspaceManagerAssignments" + ], + "description": "Deletes the specified job from the specified workspace manager assignment", + "operationId": "WorkspaceManagerAssignmentJobs_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerAssignmentName" + }, + { + "$ref": "#/parameters/JobName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "WorkspaceManagerAssignment": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The workspace manager assignment", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceManagerAssignmentProperties", + "description": "The workspace manager assignment object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WorkspaceManagerAssignmentProperties": { + "description": "The workspace manager assignment properties", + "properties": { + "targetResourceName": { + "description": "The resource name of the workspace manager group targeted by the workspace manager assignment", + "type": "string" + }, + "lastJobEndTime": { + "description": "The time the last job associated to this assignment ended at", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "lastJobProvisioningState": { + "description": "State of the last job associated to this assignment", + "enum": [ + "Succeeded", + "InProgress", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "provisioningState", + "values": [ + { + "description": "The job succeeded", + "value": "Succeeded" + }, + { + "description": "The job was canceled", + "value": "Canceled" + }, + { + "description": "The job is in progress", + "value": "InProgress" + }, + { + "description": "The job failed", + "value": "Failed" + } + ] + } + }, + "items": { + "description": "List of resources included in this workspace manager assignment", + "items": { + "$ref": "#/definitions/assignmentItem" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "required": [ + "targetResourceName", + "items" + ], + "type": "object" + }, + "assignmentItem": { + "description": "An entity describing a content item.", + "properties": { + "resourceId": { + "description": "The resource id of the content item", + "type": "string" + } + }, + "type": "object" + }, + "WorkspaceManagerAssignmentList": { + "description": "List of all the workspace manager assignments.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of workspace manager assignments.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of workspace manager assignments.", + "items": { + "$ref": "#/definitions/WorkspaceManagerAssignment" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "Job": { + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "description": "The assignment job", + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The job object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "JobProperties": { + "description": "The job properties", + "properties": { + "endTime": { + "description": "The time the job completed", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "items": { + "description": "List of items published by the job", + "items": { + "$ref": "#/definitions/jobItem" + }, + "x-ms-identifiers": [], + "type": "array" + }, + "provisioningState": { + "description": "State of the job", + "enum": [ + "Succeeded", + "InProgress", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "provisioningState", + "values": [ + { + "description": "The job succeeded", + "value": "Succeeded" + }, + { + "description": "The job was canceled", + "value": "Canceled" + }, + { + "description": "The job is in progress", + "value": "InProgress" + }, + { + "description": "The job failed", + "value": "Failed" + } + ] + } + }, + "startTime": { + "description": "The time the job started", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "Message to describe error, if an error exists", + "type": "string", + "readOnly": true + } + }, + "type": "object" + }, + "jobItem": { + "description": "An entity describing the publish status of a content item.", + "properties": { + "resourceId": { + "description": "The resource id of the content item", + "type": "string" + }, + "status": { + "description": "Status of the item publication", + "enum": [ + "Succeeded", + "Failed", + "InProgress" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "status", + "values": [ + { + "description": "The item publication succeeded", + "value": "Succeeded" + }, + { + "description": "The item publication failed", + "value": "Failed" + }, + { + "description": "The item publication is in progress", + "value": "InProgress" + } + ] + } + }, + "executionTime": { + "description": "The time the item publishing was completed", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "The list of error descriptions if the item publication fails.", + "items": { + "$ref": "#/definitions/error" + }, + "x-ms-identifiers": [], + "type": "array" + } + }, + "type": "object" + }, + "error": { + "description": "The error description for why a publication failed", + "type": "object", + "properties": { + "memberResourceName": { + "description": "The member resource name for which the publication error occured", + "type": "string" + }, + "errorMessage": { + "description": "The error message", + "type": "string" + } + }, + "required": [ + "memberResourceName", + "errorMessage" + ] + }, + "JobList": { + "description": "List of all the jobs", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of jobs.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of jobs.", + "items": { + "$ref": "#/definitions/Job" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "WorkspaceManagerAssignmentName": { + "description": "The name of the workspace manager assignment", + "in": "path", + "name": "workspaceManagerAssignmentName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + }, + "WorkspaceManagerAssignment": { + "description": "The workspace manager assignment", + "in": "body", + "name": "workspaceManagerAssignment", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceManagerAssignment" + }, + "x-ms-parameter-location": "method" + }, + "JobName": { + "description": "The job name", + "in": "path", + "name": "jobName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerConfigurations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerConfigurations.json new file mode 100644 index 000000000000..e74c35512ad3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerConfigurations.json @@ -0,0 +1,323 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations": { + "get": { + "x-ms-examples": { + "Get all workspace manager configurations for a Sentinel workspace.": { + "$ref": "./examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json" + } + }, + "tags": [ + "workspaceManagerConfigurations" + ], + "description": "Gets all workspace manager configurations for a Sentinel workspace.", + "operationId": "WorkspaceManagerConfigurations_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerConfigurationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/{workspaceManagerConfigurationName}": { + "get": { + "x-ms-examples": { + "Get a workspace manager configuration.": { + "$ref": "./examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json" + } + }, + "tags": [ + "workspaceManagerConfigurations" + ], + "description": "Gets a workspace manager configuration", + "operationId": "WorkspaceManagerConfigurations_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerConfigurationName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace manager configuration.": { + "$ref": "./examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json" + } + }, + "tags": [ + "workspaceManagerConfigurations" + ], + "description": "Deletes a workspace manager configuration", + "operationId": "WorkspaceManagerConfigurations_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerConfigurationName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or Update a workspace manager Configuration": { + "$ref": "./examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json" + } + }, + "tags": [ + "workspaceManagerConfigurations" + ], + "description": "Creates or updates a workspace manager configuration.", + "operationId": "WorkspaceManagerConfigurations_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerConfigurationName" + }, + { + "$ref": "#/parameters/WorkspaceManagerConfiguration" + } + ], + "responses": { + "200": { + "description": "OK, created or updated an instance", + "schema": { + "$ref": "#/definitions/WorkspaceManagerConfiguration" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WorkspaceManagerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "WorkspaceManagerConfiguration": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The workspace manager configuration", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceManagerConfigurationProperties", + "description": "The workspace manager configuration object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WorkspaceManagerConfigurationProperties": { + "description": "The workspace manager configuration properties", + "properties": { + "mode": { + "description": "The current mode of the workspace manager configuration", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "mode", + "values": [ + { + "description": "The workspace manager configuration is enabled", + "value": "Enabled" + }, + { + "description": "The workspace manager configuration is disabled", + "value": "Disabled" + } + ] + } + } + }, + "required": [ + "mode" + ], + "type": "object" + }, + "WorkspaceManagerConfigurationList": { + "description": "List all the workspace manager configurations for the workspace.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of workspace manager configurations.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of workspace manager configurations.", + "items": { + "$ref": "#/definitions/WorkspaceManagerConfiguration" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "WorkspaceManagerConfigurationName": { + "description": "The name of the workspace manager configuration", + "in": "path", + "name": "workspaceManagerConfigurationName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + }, + "WorkspaceManagerConfiguration": { + "description": "The workspace manager configuration", + "in": "body", + "name": "workspaceManagerConfiguration", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceManagerConfiguration" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerGroups.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerGroups.json new file mode 100644 index 000000000000..0b1f6c41d866 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerGroups.json @@ -0,0 +1,318 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerGroups": { + "get": { + "x-ms-examples": { + "Get all workspace manager groups in the Sentinel workspace manager.": { + "$ref": "./examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json" + } + }, + "tags": [ + "workspaceManagerGroups" + ], + "description": "Gets all workspace manager groups in the Sentinel workspace manager", + "operationId": "WorkspaceManagerGroups_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerGroupList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerGroups/{workspaceManagerGroupName}": { + "get": { + "x-ms-examples": { + "Get a workspace manager group": { + "$ref": "./examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json" + } + }, + "tags": [ + "workspaceManagerGroups" + ], + "description": "Gets a workspace manager group", + "operationId": "WorkspaceManagerGroups_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerGroupName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a workspace manager group.": { + "$ref": "./examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json" + } + }, + "tags": [ + "workspaceManagerGroups" + ], + "description": "Creates or updates a workspace manager group.", + "operationId": "WorkspaceManagerGroups_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerGroupName" + }, + { + "$ref": "#/parameters/WorkspaceManagerGroup" + } + ], + "responses": { + "200": { + "description": "OK, created or updated an instance", + "schema": { + "$ref": "#/definitions/WorkspaceManagerGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WorkspaceManagerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace manager group.": { + "$ref": "./examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json" + } + }, + "tags": [ + "workspaceManagerGroups" + ], + "description": "Deletes a workspace manager group", + "operationId": "WorkspaceManagerGroups_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerGroupName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "WorkspaceManagerGroup": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The workspace manager group", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceManagerGroupProperties", + "description": "The workspace manager group object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WorkspaceManagerGroupProperties": { + "description": "The workspace manager group properties", + "properties": { + "description": { + "description": "The description of the workspace manager group", + "type": "string" + }, + "displayName": { + "description": "The display name of the workspace manager group", + "type": "string" + }, + "memberResourceNames": { + "description": "The names of the workspace manager members participating in this group.", + "items": { + "description": "memberResourceName", + "type": "string" + }, + "type": "array" + } + }, + "required": [ + "displayName", + "memberResourceNames" + ], + "type": "object" + }, + "WorkspaceManagerGroupList": { + "description": "List of all the workspace manager groups.", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of workspace manager groups.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of workspace manager groups.", + "items": { + "$ref": "#/definitions/WorkspaceManagerGroup" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "WorkspaceManagerGroupName": { + "description": "The name of the workspace manager group", + "in": "path", + "name": "workspaceManagerGroupName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + }, + "WorkspaceManagerGroup": { + "description": "The workspace manager group object", + "in": "body", + "name": "workspaceManagerGroup", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceManagerGroup" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerMembers.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerMembers.json new file mode 100644 index 000000000000..3b2ae624615f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerMembers.json @@ -0,0 +1,310 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerMembers/": { + "get": { + "x-ms-examples": { + "Get all workspace manager members": { + "$ref": "./examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json" + } + }, + "tags": [ + "workspaceManagerMember" + ], + "description": "Gets all workspace manager members that exist for the given Sentinel workspace manager", + "operationId": "WorkspaceManagerMembers_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataOrderBy" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataTop" + }, + { + "$ref": "../../../common/2.0/types.json#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerMembersList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/workspaceManagerMembers/{workspaceManagerMemberName}": { + "get": { + "x-ms-examples": { + "Get a workspace manager member": { + "$ref": "./examples/workspaceManagerMembers/GetWorkspaceManagerMember.json" + } + }, + "tags": [ + "workspaceManagerMember" + ], + "description": "Gets a workspace manager member", + "operationId": "WorkspaceManagerMembers_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerMemberName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/WorkspaceManagerMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "x-ms-examples": { + "Create or Update a workspace manager member": { + "$ref": "./examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json" + } + }, + "tags": [ + "workspaceManagerMember" + ], + "description": "Creates or updates a workspace manager member", + "operationId": "WorkspaceManagerMembers_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerMemberName" + }, + { + "$ref": "#/parameters/WorkspaceManagerMember" + } + ], + "responses": { + "200": { + "description": "OK, created or updated an instance", + "schema": { + "$ref": "#/definitions/WorkspaceManagerMember" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/WorkspaceManagerMember" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a workspace manager member": { + "$ref": "./examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json" + } + }, + "tags": [ + "workspaceManagerMember" + ], + "description": "Deletes a workspace manager member", + "operationId": "WorkspaceManagerMembers_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/WorkspaceManagerMemberName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "WorkspaceManagerMemberProperties": { + "description": "The workspace manager member properties", + "properties": { + "targetWorkspaceId": { + "description": "Fully qualified resource ID of the target Sentinel workspace joining the given Sentinel workspace manager", + "type": "string" + }, + "targetWorkspaceTenantId": { + "description": "Tenant id of the target Sentinel workspace joining the given Sentinel workspace manager", + "type": "string" + } + }, + "required": [ + "targetWorkspaceId", + "targetWorkspaceTenantId" + ], + "type": "object" + }, + "WorkspaceManagerMember": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/AzureEntityResource" + } + ], + "description": "The workspace manager member", + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceManagerMemberProperties", + "description": "The workspace manager member object", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "WorkspaceManagerMembersList": { + "description": "List of workspace manager members", + "type": "object", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of workspace manager members", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of workspace manager members", + "items": { + "$ref": "#/definitions/WorkspaceManagerMember" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + } + }, + "parameters": { + "WorkspaceManagerMemberName": { + "description": "The name of the workspace manager member", + "in": "path", + "name": "workspaceManagerMemberName", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9][A-Za-z0-9-]+[A-Za-z0-9]$", + "x-ms-parameter-location": "method" + }, + "WorkspaceManagerMember": { + "description": "The workspace manager member object", + "in": "body", + "name": "workspaceManagerMember", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceManagerMember" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/AlertTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/AlertTypes.json new file mode 100644 index 000000000000..2db8c17b9291 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/AlertTypes.json @@ -0,0 +1,81 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-05-01-preview", + "title": "Common Alert types" + }, + "paths": {}, + "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" + } + } + }, + "definitions": { + "AlertSeverityEnum": { + "description": "The severity of the alert", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "AttackTactic": { + "description": "The severity for alerts created by this alert rule.", + "enum": [ + "Reconnaissance", + "ResourceDevelopment", + "InitialAccess", + "Execution", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact", + "PreAttack", + "ImpairProcessControl", + "InhibitResponseFunction" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AttackTactic" + } + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/ContentCommonTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/ContentCommonTypes.json new file mode 100644 index 000000000000..b8a7b069e8a2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/ContentCommonTypes.json @@ -0,0 +1,429 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-05-01-preview", + "title": "Common content metadata types" + }, + "paths": {}, + "definitions": { + "metadataContentId": { + "description": "Static ID for the content. Used to identify dependencies and content from solutions or community. Hard-coded/static for out of the box content and solutions. Can be optionally set for user created content to define dependencies. If an active content item is made from a metadata, both will have the same contentId.", + "type": "string" + }, + "metadataParentId": { + "description": "Full parent resource ID of the content item the metadata is for. This is the full resource ID including the scope (subscription and resource group)", + "type": "string" + }, + "metadataDisplayName": { + "description": "DisplayName of the content.", + "type": "string" + }, + "metadataVersion": { + "description": "Version of the content. Default and recommended format is numeric (e.g. 1, 1.0, 1.0.0, 1.0.0.0), following ARM template best practices. Can also be any string, but then we cannot guarantee any version checks", + "type": "string" + }, + "metadataPackageKind": { + "description": "The package kind", + "enum": [ + "Solution", + "Standalone" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "packageKind", + "values": [ + { + "value": "Solution" + }, + { + "value": "Standalone" + } + ] + } + }, + "metadataKind": { + "type": "string", + "description": "The kind of content the metadata is for.", + "enum": [ + "DataConnector", + "DataType", + "Workbook", + "WorkbookTemplate", + "Playbook", + "PlaybookTemplate", + "AnalyticsRuleTemplate", + "AnalyticsRule", + "HuntingQuery", + "InvestigationQuery", + "Parser", + "Watchlist", + "WatchlistTemplate", + "Solution", + "AzureFunction", + "LogicAppsCustomConnector", + "AutomationRule" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "kind", + "values": [ + { + "value": "DataConnector" + }, + { + "value": "DataType" + }, + { + "value": "Workbook" + }, + { + "value": "WorkbookTemplate" + }, + { + "value": "Playbook" + }, + { + "value": "PlaybookTemplate" + }, + { + "value": "AnalyticsRuleTemplate" + }, + { + "value": "AnalyticsRule" + }, + { + "value": "HuntingQuery" + }, + { + "value": "InvestigationQuery" + }, + { + "value": "Parser" + }, + { + "value": "Watchlist" + }, + { + "value": "WatchlistTemplate" + }, + { + "value": "Solution" + }, + { + "value": "AzureFunction" + }, + { + "value": "LogicAppsCustomConnector" + }, + { + "value": "AutomationRule" + } + ] + } + }, + "metadataTrueFalseFlag": { + "type": "string", + "description": "The boolean value the metadata is for.", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "flag", + "values": [ + { + "value": "true" + }, + { + "value": "false" + } + ] + } + }, + "metadataSource": { + "description": "The original source of the content item, where it comes from.", + "type": "object", + "required": [ + "kind" + ], + "properties": { + "kind": { + "description": "Source type of the content", + "type": "string", + "enum": [ + "LocalWorkspace", + "Community", + "Solution", + "SourceRepository" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "sourceKind", + "values": [ + { + "value": "LocalWorkspace" + }, + { + "value": "Community" + }, + { + "value": "Solution" + }, + { + "value": "SourceRepository" + } + ] + } + }, + "name": { + "description": "Name of the content source. The repo name, solution name, LA workspace name etc.", + "type": "string" + }, + "sourceId": { + "description": "ID of the content source. The solution ID, workspace ID, etc", + "type": "string" + } + } + }, + "metadataAuthor": { + "type": "object", + "description": "Publisher or creator of the content item.", + "properties": { + "name": { + "description": "Name of the author. Company or person.", + "type": "string" + }, + "email": { + "description": "Email of author contact", + "type": "string" + }, + "link": { + "description": "Link for author/vendor page", + "type": "string" + } + } + }, + "metadataSupport": { + "type": "object", + "description": "Support information for the content item.", + "required": [ + "tier" + ], + "properties": { + "tier": { + "description": "Type of support for content item", + "type": "string", + "enum": [ + "Microsoft", + "Partner", + "Community" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "supportTier", + "values": [ + { + "value": "Microsoft" + }, + { + "value": "Partner" + }, + { + "value": "Community" + } + ] + } + }, + "name": { + "description": "Name of the support contact. Company or person.", + "type": "string" + }, + "email": { + "description": "Email of support contact", + "type": "string" + }, + "link": { + "description": "Link for support help, like to support page to open a ticket etc.", + "type": "string" + } + } + }, + "metadataDependencies": { + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex dependencies.", + "type": "object", + "properties": { + "contentId": { + "description": "Id of the content item we depend on", + "$ref": "#/definitions/metadataContentId" + }, + "kind": { + "description": "Type of the content item we depend on", + "$ref": "#/definitions/metadataKind" + }, + "version": { + "description": "Version of the the content item we depend on. Can be blank, * or missing to indicate any version fulfills the dependency. If version does not match our defined numeric format then an exact match is required.", + "$ref": "#/definitions/metadataVersion" + }, + "name": { + "description": "Name of the content item", + "type": "string" + }, + "operator": { + "description": "Operator used for list of dependencies in criteria array.", + "type": "string", + "enum": [ + "AND", + "OR" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "operator", + "values": [ + { + "value": "AND" + }, + { + "value": "OR" + } + ] + } + }, + "criteria": { + "description": "This is the list of dependencies we must fulfill, according to the AND/OR operator", + "type": "array", + "items": { + "$ref": "#/definitions/metadataDependencies", + "description": "Dependencies for the content item, what other content items it requires to work. Can describe more complex dependencies using a recursive/nested structure. For a single dependency an id/kind/version can be supplied or operator/criteria for complex formats." + }, + "x-ms-identifiers": [ + "contentId" + ] + } + } + }, + "metadataCategories": { + "type": "object", + "description": "ies for the solution content item", + "properties": { + "domains": { + "description": "domain for the solution content item", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "verticals": { + "description": "Industry verticals for the solution content item", + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "str1", + "str2", + "str3" + ] + } + } + }, + "metadataProviders": { + "description": "Providers for the solution content item", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + }, + "metadataFirstPublishDate": { + "description": "first publish date of solution content item", + "type": "string", + "format": "date" + }, + "metadataLastPublishDate": { + "description": "last publish date of solution content item", + "type": "string", + "format": "date" + }, + "metadataCustomVersion": { + "description": "The custom version of the content. A optional free text", + "type": "string" + }, + "metadataContentSchemaVersion": { + "description": "Schema version of the content. Can be used to distinguish between different flow based on the schema version", + "type": "string" + }, + "metadataIcon": { + "description": "the icon identifier. this id can later be fetched from the metadata", + "type": "string" + }, + "metadataThreatAnalysisTactics": { + "description": "the tactics the resource covers", + "type": "array", + "example": [ + "reconnaissance", + "exfiltration" + ], + "items": { + "type": "string" + } + }, + "metadataThreatAnalysisTechniques": { + "description": "the techniques the resource covers, these have to be aligned with the tactics being used", + "type": "array", + "example": [ + "T1548", + "T1548.001", + "T1134.003" + ], + "items": { + "type": "string" + } + }, + "metadataPreviewImages": { + "description": "preview image file names. These will be taken from the solution artifacts", + "type": "array", + "example": [ + "example.png", + "example2.jpeg" + ], + "items": { + "type": "string" + } + }, + "metadataPreviewImagesDark": { + "description": "preview image file names. These will be taken from the solution artifacts. used for dark theme support", + "type": "array", + "example": [ + "example.png", + "example2.jpeg" + ], + "items": { + "type": "string" + } + }, + "metadataTags": { + "description": "the tags assigned to the resource", + "type": "array", + "example": [ + "str1", + "str2", + "str3" + ], + "items": { + "type": "string" + } + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/EntityTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/EntityTypes.json new file mode 100644 index 000000000000..9ba3f61190b8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/EntityTypes.json @@ -0,0 +1,2550 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-05-01-preview", + "title": "Common Entity types" + }, + "paths": {}, + "definitions": { + "AccountEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an account entity.", + "properties": { + "properties": { + "$ref": "#/definitions/AccountEntityProperties", + "description": "Account entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Account" + }, + "AccountEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Account entity property bag.", + "properties": { + "aadTenantId": { + "description": "The Azure Active Directory tenant id.", + "readOnly": true, + "type": "string" + }, + "aadUserId": { + "description": "The Azure Active Directory user id.", + "readOnly": true, + "type": "string" + }, + "accountName": { + "description": "The name of the account. This field should hold only the name without any domain added to it, i.e. administrator.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name of the account.", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id that contains the account in case it is a local account (not domain joined)", + "readOnly": true, + "type": "string" + }, + "isDomainJoined": { + "description": "Determines whether this is a domain account.", + "readOnly": true, + "type": "boolean" + }, + "ntDomain": { + "description": "The NetBIOS domain name as it appears in the alert format domain/username. Examples: NT AUTHORITY.", + "readOnly": true, + "type": "string" + }, + "objectGuid": { + "description": "The objectGUID attribute is a single-value attribute that is the unique identifier for the object, assigned by active directory.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "puid": { + "description": "The Azure Active Directory Passport User ID.", + "readOnly": true, + "type": "string" + }, + "sid": { + "description": "The account security identifier, e.g. S-1-5-18.", + "readOnly": true, + "type": "string" + }, + "upnSuffix": { + "description": "The user principal name suffix for the account, in some cases it is also the domain name. Examples: contoso.com.", + "readOnly": true, + "type": "string" + }, + "dnsDomain": { + "description": "The fully qualified domain DNS name.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AzureResourceEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an azure resource entity.", + "properties": { + "properties": { + "$ref": "#/definitions/AzureResourceEntityProperties", + "description": "AzureResource entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureResource" + }, + "AzureResourceEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "AzureResource entity property bag.", + "properties": { + "resourceId": { + "description": "The azure resource id of the resource", + "readOnly": true, + "type": "string" + }, + "subscriptionId": { + "description": "The subscription id of the resource", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CloudApplicationEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a cloud application entity.", + "properties": { + "properties": { + "$ref": "#/definitions/CloudApplicationEntityProperties", + "description": "CloudApplication entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "CloudApplication" + }, + "CloudApplicationEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "CloudApplication entity property bag.", + "properties": { + "appId": { + "description": "The technical identifier of the application.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "appName": { + "description": "The name of the related cloud application.", + "readOnly": true, + "type": "string" + }, + "instanceName": { + "description": "The user defined instance name of the cloud application. It is often used to distinguish between several applications of the same type that a customer has.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DnsEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a dns entity.", + "properties": { + "properties": { + "$ref": "#/definitions/DnsEntityProperties", + "description": "Dns entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "DnsResolution" + }, + "DnsEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Dns entity property bag.", + "properties": { + "dnsServerIpEntityId": { + "description": "An ip entity id for the dns server resolving the request", + "readOnly": true, + "type": "string" + }, + "domainName": { + "description": "The name of the dns record associated with the alert", + "readOnly": true, + "type": "string" + }, + "hostIpAddressEntityId": { + "description": "An ip entity id for the dns request client", + "readOnly": true, + "type": "string" + }, + "ipAddressEntityIds": { + "description": "Ip entity identifiers for the resolved ip address.", + "items": { + "description": "Ip entity id", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "Entity": { + "allOf": [ + { + "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/Resource" + } + ], + "properties": { + "kind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the entity." + } + }, + "description": "Specific entity.", + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "EntityCommonProperties": { + "description": "Entity common property bag.", + "properties": { + "additionalData": { + "additionalProperties": true, + "description": "A bag of custom fields that should be part of the entity and will be presented to the user.", + "readOnly": true, + "type": "object" + }, + "friendlyName": { + "description": "The graph item display name which is a short humanly readable description of the graph item instance. This property is optional and might be system generated.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "EntityInnerKind": { + "description": "The kind of the entity", + "enum": [ + "Account", + "Host", + "File", + "AzureResource", + "CloudApplication", + "DnsResolution", + "FileHash", + "Ip", + "Malware", + "Process", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "Url", + "IoTDevice", + "SecurityAlert", + "Bookmark", + "Mailbox", + "MailCluster", + "MailMessage", + "SubmissionMail", + "Nic" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityKindEnum", + "values": [ + { + "description": "Entity represents account in the system.", + "value": "Account" + }, + { + "description": "Entity represents host in the system.", + "value": "Host" + }, + { + "description": "Entity represents file in the system.", + "value": "File" + }, + { + "description": "Entity represents azure resource in the system.", + "value": "AzureResource" + }, + { + "description": "Entity represents cloud application in the system.", + "value": "CloudApplication" + }, + { + "description": "Entity represents dns resolution in the system.", + "value": "DnsResolution" + }, + { + "description": "Entity represents file hash in the system.", + "value": "FileHash" + }, + { + "description": "Entity represents ip in the system.", + "value": "Ip" + }, + { + "description": "Entity represents malware in the system.", + "value": "Malware" + }, + { + "description": "Entity represents process in the system.", + "value": "Process" + }, + { + "description": "Entity represents registry key in the system.", + "value": "RegistryKey" + }, + { + "description": "Entity represents registry value in the system.", + "value": "RegistryValue" + }, + { + "description": "Entity represents security group in the system.", + "value": "SecurityGroup" + }, + { + "description": "Entity represents url in the system.", + "value": "Url" + }, + { + "description": "Entity represents IoT device in the system.", + "value": "IoTDevice" + }, + { + "description": "Entity represents security alert in the system.", + "value": "SecurityAlert" + }, + { + "description": "Entity represents bookmark in the system.", + "value": "Bookmark" + }, + { + "description": "Entity represents mail cluster in the system.", + "value": "MailCluster" + }, + { + "description": "Entity represents mail message in the system.", + "value": "MailMessage" + }, + { + "description": "Entity represents mailbox in the system.", + "value": "Mailbox" + }, + { + "description": "Entity represents submission mail in the system.", + "value": "SubmissionMail" + }, + { + "description": "Entity represents network interface in the system.", + "value": "Nic" + } + ] + } + }, + "EntityInnerType": { + "description": "The type of the entity", + "enum": [ + "Account", + "Host", + "File", + "AzureResource", + "CloudApplication", + "DNS", + "FileHash", + "IP", + "Malware", + "Process", + "RegistryKey", + "RegistryValue", + "SecurityGroup", + "URL", + "IoTDevice", + "SecurityAlert", + "HuntingBookmark", + "MailCluster", + "MailMessage", + "Mailbox", + "SubmissionMail", + "Nic" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityType", + "values": [ + { + "description": "Entity represents account in the system.", + "value": "Account" + }, + { + "description": "Entity represents host in the system.", + "value": "Host" + }, + { + "description": "Entity represents file in the system.", + "value": "File" + }, + { + "description": "Entity represents azure resource in the system.", + "value": "AzureResource" + }, + { + "description": "Entity represents cloud application in the system.", + "value": "CloudApplication" + }, + { + "description": "Entity represents dns in the system.", + "value": "DNS" + }, + { + "description": "Entity represents file hash in the system.", + "value": "FileHash" + }, + { + "description": "Entity represents ip in the system.", + "value": "IP" + }, + { + "description": "Entity represents malware in the system.", + "value": "Malware" + }, + { + "description": "Entity represents process in the system.", + "value": "Process" + }, + { + "description": "Entity represents registry key in the system.", + "value": "RegistryKey" + }, + { + "description": "Entity represents registry value in the system.", + "value": "RegistryValue" + }, + { + "description": "Entity represents security group in the system.", + "value": "SecurityGroup" + }, + { + "description": "Entity represents url in the system.", + "value": "URL" + }, + { + "description": "Entity represents IoT device in the system.", + "value": "IoTDevice" + }, + { + "description": "Entity represents security alert in the system.", + "value": "SecurityAlert" + }, + { + "description": "Entity represents HuntingBookmark in the system.", + "value": "HuntingBookmark" + }, + { + "description": "Entity represents mail cluster in the system.", + "value": "MailCluster" + }, + { + "description": "Entity represents mail message in the system.", + "value": "MailMessage" + }, + { + "description": "Entity represents mailbox in the system.", + "value": "Mailbox" + }, + { + "description": "Entity represents submission mail in the system.", + "value": "SubmissionMail" + }, + { + "description": "Entity represents network interface in the system.", + "value": "Nic" + } + ] + } + }, + "EntityQueryKind": { + "description": "The kind of the entity query", + "enum": [ + "Expansion", + "Insight", + "Activity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "EntityQueryKind", + "values": [ + { + "value": "Expansion" + }, + { + "value": "Insight" + }, + { + "value": "Activity" + } + ] + } + }, + "ExpansionResultAggregation": { + "description": "Information of a specific aggregation in the expansion result.", + "properties": { + "aggregationType": { + "description": "The common type of the aggregation. (for e.g. entity field name)", + "type": "string" + }, + "count": { + "description": "Total number of aggregations of the given kind (and aggregationType if given) in the expansion result.", + "type": "integer", + "format": "int32" + }, + "displayName": { + "description": "The display name of the aggregation by type.", + "type": "string" + }, + "entityKind": { + "$ref": "#/definitions/EntityInnerKind", + "description": "The kind of the aggregated entity." + } + }, + "required": [ + "entityKind", + "count" + ], + "type": "object" + }, + "ExpansionResultsMetadata": { + "description": "Expansion result metadata.", + "properties": { + "aggregations": { + "description": "Information of the aggregated nodes in the expansion result.", + "items": { + "$ref": "#/definitions/ExpansionResultAggregation" + }, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "FileEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a file entity.", + "properties": { + "properties": { + "$ref": "#/definitions/FileEntityProperties", + "description": "File entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "File" + }, + "FileEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "File entity property bag.", + "properties": { + "directory": { + "description": "The full path to the file.", + "readOnly": true, + "type": "string" + }, + "fileHashEntityIds": { + "description": "The file hash entity identifiers associated with this file", + "items": { + "description": "file hash id", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "fileName": { + "description": "The file name without path (some alerts might not include path).", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id which the file belongs to", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "FileHashEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a file hash entity.", + "properties": { + "properties": { + "$ref": "#/definitions/FileHashEntityProperties", + "description": "FileHash entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "FileHash" + }, + "FileHashEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "FileHash entity property bag.", + "properties": { + "algorithm": { + "description": "The hash algorithm type.", + "enum": [ + "Unknown", + "MD5", + "SHA1", + "SHA256", + "SHA256AC" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "FileHashAlgorithm", + "values": [ + { + "description": "Unknown hash algorithm", + "value": "Unknown" + }, + { + "description": "MD5 hash type", + "value": "MD5" + }, + { + "description": "SHA1 hash type", + "value": "SHA1" + }, + { + "description": "SHA256 hash type", + "value": "SHA256" + }, + { + "description": "SHA256 Authenticode hash type", + "value": "SHA256AC" + } + ] + } + }, + "hashValue": { + "description": "The file hash value.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "HostEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a host entity.", + "properties": { + "properties": { + "$ref": "#/definitions/HostEntityProperties", + "description": "Host entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Host" + }, + "HostEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Host entity property bag.", + "properties": { + "azureID": { + "description": "The azure resource id of the VM.", + "readOnly": true, + "type": "string" + }, + "dnsDomain": { + "description": "The DNS domain that this host belongs to. Should contain the compete DNS suffix for the domain", + "readOnly": true, + "type": "string" + }, + "hostName": { + "description": "The hostname without the domain suffix.", + "readOnly": true, + "type": "string" + }, + "isDomainJoined": { + "description": "Determines whether this host belongs to a domain.", + "readOnly": true, + "type": "boolean" + }, + "netBiosName": { + "description": "The host name (pre-windows2000).", + "readOnly": true, + "type": "string" + }, + "ntDomain": { + "description": "The NT domain that this host belongs to.", + "readOnly": true, + "type": "string" + }, + "omsAgentID": { + "description": "The OMS agent id, if the host has OMS agent installed.", + "readOnly": true, + "type": "string" + }, + "osFamily": { + "description": "The operating system type.", + "enum": [ + "Linux", + "Windows", + "Android", + "IOS", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "OSFamily", + "values": [ + { + "description": "Host with Linux operating system.", + "value": "Linux" + }, + { + "description": "Host with Windows operating system.", + "value": "Windows" + }, + { + "description": "Host with Android operating system.", + "value": "Android" + }, + { + "description": "Host with IOS operating system.", + "value": "IOS" + }, + { + "description": "Host with Unknown operating system.", + "value": "Unknown" + } + ] + } + }, + "osVersion": { + "description": "A free text representation of the operating system. This field is meant to hold specific versions the are more fine grained than OSFamily or future values not supported by OSFamily enumeration", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "HuntingBookmark": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a Hunting bookmark entity.", + "properties": { + "properties": { + "$ref": "#/definitions/HuntingBookmarkProperties", + "description": "HuntingBookmark entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Bookmark" + }, + "HuntingBookmarkProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Describes bookmark properties", + "properties": { + "created": { + "description": "The time the bookmark was created", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "../../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "displayName": { + "description": "The display name of the bookmark", + "type": "string" + }, + "eventTime": { + "description": "The time of the event", + "format": "date-time", + "type": "string" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "../../../../common/2.0/types.json#/definitions/Label" + }, + "type": "array", + "x-ms-identifiers": [] + }, + "notes": { + "description": "The notes of the bookmark", + "type": "string" + }, + "query": { + "description": "The query of the bookmark.", + "type": "string" + }, + "queryResult": { + "description": "The query result of the bookmark.", + "type": "string" + }, + "updated": { + "description": "The last time the bookmark was updated", + "format": "date-time", + "type": "string" + }, + "updatedBy": { + "$ref": "../../../../common/2.0/types.json#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "incidentInfo": { + "$ref": "IncidentTypes.json#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" + } + }, + "required": [ + "displayName", + "query" + ], + "type": "object" + }, + "IoTDeviceEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an IoT device entity.", + "properties": { + "properties": { + "$ref": "#/definitions/IoTDeviceEntityProperties", + "description": "IoTDevice entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "IoTDevice" + }, + "IoTDeviceEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "IoTDevice entity property bag.", + "properties": { + "deviceId": { + "description": "The ID of the IoT Device in the IoT Hub", + "readOnly": true, + "type": "string" + }, + "deviceName": { + "description": "The friendly name of the device", + "readOnly": true, + "type": "string" + }, + "source": { + "description": "The source of the device", + "readOnly": true, + "type": "string" + }, + "iotSecurityAgentId": { + "description": "The ID of the security agent running on the device", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "deviceType": { + "description": "The type of the device", + "readOnly": true, + "type": "string" + }, + "vendor": { + "description": "The vendor of the device", + "readOnly": true, + "type": "string" + }, + "edgeId": { + "description": "The ID of the edge device", + "readOnly": true, + "type": "string" + }, + "macAddress": { + "description": "The MAC address of the device", + "readOnly": true, + "type": "string" + }, + "model": { + "description": "The model of the device", + "readOnly": true, + "type": "string" + }, + "serialNumber": { + "description": "The serial number of the device", + "readOnly": true, + "type": "string" + }, + "firmwareVersion": { + "description": "The firmware version of the device", + "readOnly": true, + "type": "string" + }, + "operatingSystem": { + "description": "The operating system of the device", + "readOnly": true, + "type": "string" + }, + "iotHubEntityId": { + "description": "The AzureResource entity id of the IoT Hub", + "readOnly": true, + "type": "string" + }, + "hostEntityId": { + "description": "The Host entity id of this device", + "readOnly": true, + "type": "string" + }, + "ipAddressEntityId": { + "description": "The IP entity if of this device", + "readOnly": true, + "type": "string" + }, + "threatIntelligence": { + "description": "A list of TI contexts attached to the IoTDevice entity.", + "items": { + "$ref": "ThreatIntelligenceTypes.json#/definitions/ThreatIntelligence" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "protocols": { + "description": "A list of protocols of the IoTDevice entity.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "owners": { + "description": "A list of owners of the IoTDevice entity.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "nicEntityIds": { + "description": "A list of Nic entity ids of the IoTDevice entity.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "site": { + "description": "The site of the device", + "readOnly": true, + "type": "string" + }, + "zone": { + "description": "The zone location of the device within a site", + "readOnly": true, + "type": "string" + }, + "sensor": { + "description": "The sensor the device is monitored by", + "readOnly": true, + "type": "string" + }, + "deviceSubType": { + "description": "The subType of the device ('PLC', 'HMI', 'EWS', etc.)", + "readOnly": true, + "type": "string" + }, + "importance": { + "description": "Device importance, determines if the device classified as 'crown jewel'", + "enum": [ + "Unknown", + "Low", + "Normal", + "High" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DeviceImportance", + "values": [ + { + "description": "Unknown - Default value", + "value": "Unknown" + }, + { + "description": "Low", + "value": "Low" + }, + { + "description": "Normal", + "value": "Normal" + }, + { + "description": "High", + "value": "High" + } + ] + } + }, + "purdueLayer": { + "description": "The Purdue Layer of the device", + "readOnly": true, + "type": "string" + }, + "isAuthorized": { + "description": "Determines whether the device classified as authorized device", + "readOnly": true, + "type": "boolean" + }, + "isProgramming": { + "description": "Determines whether the device classified as programming device", + "readOnly": true, + "type": "boolean" + }, + "isScanner": { + "description": "Is the device classified as a scanner device", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "IpEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an ip entity.", + "properties": { + "properties": { + "$ref": "#/definitions/IpEntityProperties", + "description": "Ip entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Ip" + }, + "IpEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Ip entity property bag.", + "properties": { + "address": { + "description": "The IP address as string, e.g. 127.0.0.1 (either in Ipv4 or Ipv6)", + "readOnly": true, + "type": "string" + }, + "location": { + "$ref": "#/definitions/GeoLocation", + "description": "The geo-location context attached to the ip entity" + }, + "threatIntelligence": { + "description": "A list of TI contexts attached to the ip entity.", + "items": { + "$ref": "ThreatIntelligenceTypes.json#/definitions/ThreatIntelligence" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "GeoLocation": { + "description": "The geo-location context attached to the ip entity", + "properties": { + "asn": { + "description": "Autonomous System Number", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "city": { + "description": "City name", + "readOnly": true, + "type": "string" + }, + "countryCode": { + "description": "The country code according to ISO 3166 format", + "readOnly": true, + "type": "string" + }, + "countryName": { + "description": "Country name according to ISO 3166 Alpha 2: the lowercase of the English Short Name", + "readOnly": true, + "type": "string" + }, + "latitude": { + "description": "The latitude of the identified location, expressed as a floating point number with range of - 90 to 90. Latitude and longitude are derived from the city or postal code.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "longitude": { + "description": "The longitude of the identified location, expressed as a floating point number with range of -180 to 180. Latitude and longitude are derived from the city or postal code.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "state": { + "description": "State name", + "readOnly": true, + "type": "string" + } + }, + "readOnly": true, + "type": "object" + }, + "MailboxEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mailbox entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailboxEntityProperties", + "description": "Mailbox entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Mailbox" + }, + "MailboxEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mailbox entity property bag.", + "properties": { + "mailboxPrimaryAddress": { + "description": "The mailbox's primary address", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The mailbox's display name", + "readOnly": true, + "type": "string" + }, + "upn": { + "description": "The mailbox's UPN", + "readOnly": true, + "type": "string" + }, + "externalDirectoryObjectId": { + "description": "The AzureAD identifier of mailbox. Similar to AadUserId in account entity but this property is specific to mailbox object on office side", + "format": "uuid", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MailClusterEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mail cluster entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailClusterEntityProperties", + "description": "Mail cluster entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MailCluster" + }, + "MailClusterEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mail cluster entity property bag.", + "properties": { + "networkMessageIds": { + "description": "The mail message IDs that are part of the mail cluster", + "items": { + "description": "A mail message ID", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "countByDeliveryStatus": { + "description": "Count of mail messages by DeliveryStatus string representation", + "readOnly": true, + "type": "object" + }, + "countByThreatType": { + "description": "Count of mail messages by ThreatType string representation", + "readOnly": true, + "type": "object" + }, + "countByProtectionStatus": { + "description": "Count of mail messages by ProtectionStatus string representation", + "readOnly": true, + "type": "object" + }, + "threats": { + "description": "The threats of mail messages that are part of the mail cluster", + "items": { + "description": "A threat", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "query": { + "description": "The query that was used to identify the messages of the mail cluster", + "readOnly": true, + "type": "string" + }, + "queryTime": { + "description": "The query time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "mailCount": { + "description": "The number of mail messages that are part of the mail cluster", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "isVolumeAnomaly": { + "description": "Is this a volume anomaly mail cluster", + "readOnly": true, + "type": "boolean" + }, + "source": { + "description": "The source of the mail cluster (default is 'O365 ATP')", + "readOnly": true, + "type": "string" + }, + "clusterSourceIdentifier": { + "description": "The id of the cluster source", + "readOnly": true, + "type": "string" + }, + "clusterSourceType": { + "description": "The type of the cluster source", + "readOnly": true, + "type": "string" + }, + "clusterQueryStartTime": { + "description": "The cluster query start time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "clusterQueryEndTime": { + "description": "The cluster query end time", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "clusterGroup": { + "description": "The cluster group", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "MailMessageEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a mail message entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MailMessageEntityProperties", + "description": "Mail message entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MailMessage" + }, + "MailMessageEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Mail message entity property bag.", + "properties": { + "fileEntityIds": { + "description": "The File entity ids of this mail message's attachments", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "recipient": { + "description": "The recipient of this mail message. Note that in case of multiple recipients the mail message is forked and each copy has one recipient", + "readOnly": true, + "type": "string" + }, + "urls": { + "description": "The Urls contained in this mail message", + "items": { + "description": "A Url contained in this mail message", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "threats": { + "description": "The threats of this mail message", + "items": { + "description": "A threat of the mail message", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "p1Sender": { + "description": "The p1 sender's email address", + "readOnly": true, + "type": "string" + }, + "p1SenderDisplayName": { + "description": "The p1 sender's display name", + "readOnly": true, + "type": "string" + }, + "p1SenderDomain": { + "description": "The p1 sender's domain", + "readOnly": true, + "type": "string" + }, + "senderIP": { + "description": "The sender's IP address", + "readOnly": true, + "type": "string" + }, + "p2Sender": { + "description": "The p2 sender's email address", + "readOnly": true, + "type": "string" + }, + "p2SenderDisplayName": { + "description": "The p2 sender's display name", + "readOnly": true, + "type": "string" + }, + "p2SenderDomain": { + "description": "The p2 sender's domain", + "readOnly": true, + "type": "string" + }, + "receiveDate": { + "description": "The receive date of this message", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "networkMessageId": { + "description": "The network message id of this mail message", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "internetMessageId": { + "description": "The internet message id of this mail message", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The subject of this mail message", + "readOnly": true, + "type": "string" + }, + "language": { + "description": "The language of this mail message", + "readOnly": true, + "type": "string" + }, + "threatDetectionMethods": { + "description": "The threat detection methods", + "items": { + "description": "A threat detection method", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "bodyFingerprintBin1": { + "description": "The bodyFingerprintBin1", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin2": { + "description": "The bodyFingerprintBin2", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin3": { + "description": "The bodyFingerprintBin3", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin4": { + "description": "The bodyFingerprintBin4", + "type": "integer", + "format": "int32" + }, + "bodyFingerprintBin5": { + "description": "The bodyFingerprintBin5", + "type": "integer", + "format": "int32" + }, + "antispamDirection": { + "description": "The directionality of this mail message", + "enum": [ + "Unknown", + "Inbound", + "Outbound", + "Intraorg" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AntispamMailDirection", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "Inbound", + "value": "Inbound" + }, + { + "description": "Outbound", + "value": "Outbound" + }, + { + "description": "Intraorg", + "value": "Intraorg" + } + ] + } + }, + "deliveryAction": { + "description": "The delivery action of this mail message like Delivered, Blocked, Replaced etc", + "enum": [ + "Unknown", + "DeliveredAsSpam", + "Delivered", + "Blocked", + "Replaced" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "DeliveryAction", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "DeliveredAsSpam", + "value": "DeliveredAsSpam" + }, + { + "description": "Delivered", + "value": "Delivered" + }, + { + "description": "Blocked", + "value": "Blocked" + }, + { + "description": "Replaced", + "value": "Replaced" + } + ] + } + }, + "deliveryLocation": { + "description": "The delivery location of this mail message like Inbox, JunkFolder etc", + "enum": [ + "Unknown", + "Inbox", + "JunkFolder", + "DeletedFolder", + "Quarantine", + "External", + "Failed", + "Dropped", + "Forwarded" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "DeliveryLocation", + "values": [ + { + "description": "Unknown", + "value": "Unknown" + }, + { + "description": "Inbox", + "value": "Inbox" + }, + { + "description": "JunkFolder", + "value": "JunkFolder" + }, + { + "description": "DeletedFolder", + "value": "DeletedFolder" + }, + { + "description": "Quarantine", + "value": "Quarantine" + }, + { + "description": "External", + "value": "External" + }, + { + "description": "Failed", + "value": "Failed" + }, + { + "description": "Dropped", + "value": "Dropped" + }, + { + "description": "Forwarded", + "value": "Forwarded" + } + ] + } + } + }, + "type": "object" + }, + "MalwareEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a malware entity.", + "properties": { + "properties": { + "$ref": "#/definitions/MalwareEntityProperties", + "description": "File entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Malware" + }, + "MalwareEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Malware entity property bag.", + "properties": { + "category": { + "description": "The malware category by the vendor, e.g. Trojan", + "readOnly": true, + "type": "string" + }, + "fileEntityIds": { + "description": "List of linked file entity identifiers on which the malware was found", + "items": { + "description": "file entity id", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "malwareName": { + "description": "The malware name by the vendor, e.g. Win32/Toga!rfn", + "readOnly": true, + "type": "string" + }, + "processEntityIds": { + "description": "List of linked process entity identifiers on which the malware was found.", + "items": { + "description": "process entity id", + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "ProcessEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a process entity.", + "properties": { + "properties": { + "$ref": "#/definitions/ProcessEntityProperties", + "description": "Process entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Process" + }, + "ProcessEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Process entity property bag.", + "properties": { + "accountEntityId": { + "description": "The account entity id running the processes.", + "readOnly": true, + "type": "string" + }, + "commandLine": { + "description": "The command line used to create the process", + "readOnly": true, + "type": "string" + }, + "creationTimeUtc": { + "description": "The time when the process started to run", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "elevationToken": { + "description": "The elevation token associated with the process.", + "enum": [ + "Default", + "Full", + "Limited" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "ElevationToken", + "values": [ + { + "description": "Default elevation token", + "value": "Default" + }, + { + "description": "Full elevation token", + "value": "Full" + }, + { + "description": "Limited elevation token", + "value": "Limited" + } + ] + } + }, + "hostEntityId": { + "description": "The host entity id on which the process was running", + "readOnly": true, + "type": "string" + }, + "hostLogonSessionEntityId": { + "description": "The session entity id in which the process was running", + "readOnly": true, + "type": "string" + }, + "imageFileEntityId": { + "description": "Image file entity id", + "readOnly": true, + "type": "string" + }, + "parentProcessEntityId": { + "description": "The parent process entity id.", + "readOnly": true, + "type": "string" + }, + "processId": { + "description": "The process ID", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RegistryKeyEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a registry key entity.", + "properties": { + "properties": { + "$ref": "#/definitions/RegistryKeyEntityProperties", + "description": "RegistryKey entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "RegistryKey" + }, + "RegistryKeyEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "RegistryKey entity property bag.", + "properties": { + "hive": { + "description": "the hive that holds the registry key.", + "enum": [ + "HKEY_LOCAL_MACHINE", + "HKEY_CLASSES_ROOT", + "HKEY_CURRENT_CONFIG", + "HKEY_USERS", + "HKEY_CURRENT_USER_LOCAL_SETTINGS", + "HKEY_PERFORMANCE_DATA", + "HKEY_PERFORMANCE_NLSTEXT", + "HKEY_PERFORMANCE_TEXT", + "HKEY_A", + "HKEY_CURRENT_USER" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RegistryHive", + "values": [ + { + "description": "HKEY_LOCAL_MACHINE", + "value": "HKEY_LOCAL_MACHINE" + }, + { + "description": "HKEY_CLASSES_ROOT", + "value": "HKEY_CLASSES_ROOT" + }, + { + "description": "HKEY_CURRENT_CONFIG", + "value": "HKEY_CURRENT_CONFIG" + }, + { + "description": "HKEY_USERS", + "value": "HKEY_USERS" + }, + { + "description": "HKEY_CURRENT_USER_LOCAL_SETTINGS", + "value": "HKEY_CURRENT_USER_LOCAL_SETTINGS" + }, + { + "description": "HKEY_PERFORMANCE_DATA", + "value": "HKEY_PERFORMANCE_DATA" + }, + { + "description": "HKEY_PERFORMANCE_NLSTEXT", + "value": "HKEY_PERFORMANCE_NLSTEXT" + }, + { + "description": "HKEY_PERFORMANCE_TEXT", + "value": "HKEY_PERFORMANCE_TEXT" + }, + { + "description": "HKEY_A", + "value": "HKEY_A" + }, + { + "description": "HKEY_CURRENT_USER", + "value": "HKEY_CURRENT_USER" + } + ] + } + }, + "key": { + "description": "The registry key path.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "RegistryValueEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a registry value entity.", + "properties": { + "properties": { + "$ref": "#/definitions/RegistryValueEntityProperties", + "description": "RegistryKey entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "RegistryValue" + }, + "RegistryValueEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "RegistryValue entity property bag.", + "properties": { + "keyEntityId": { + "description": "The registry key entity id.", + "readOnly": true, + "type": "string" + }, + "valueData": { + "description": "String formatted representation of the value data.", + "readOnly": true, + "type": "string" + }, + "valueName": { + "description": "The registry value name.", + "readOnly": true, + "type": "string" + }, + "valueType": { + "description": "Specifies the data types to use when storing values in the registry, or identifies the data type of a value in the registry.", + "enum": [ + "None", + "Unknown", + "String", + "ExpandString", + "Binary", + "DWord", + "MultiString", + "QWord" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "RegistryValueKind", + "values": [ + { + "description": "None", + "value": "None" + }, + { + "description": "Unknown value type", + "value": "Unknown" + }, + { + "description": "String value type", + "value": "String" + }, + { + "description": "ExpandString value type", + "value": "ExpandString" + }, + { + "description": "Binary value type", + "value": "Binary" + }, + { + "description": "DWord value type", + "value": "DWord" + }, + { + "description": "MultiString value type", + "value": "MultiString" + }, + { + "description": "QWord value type", + "value": "QWord" + } + ] + } + } + }, + "type": "object" + }, + "SecurityAlert": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a security alert entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertProperties", + "description": "SecurityAlert entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SecurityAlert" + }, + "SecurityAlertProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "SecurityAlert entity property bag.", + "properties": { + "alertDisplayName": { + "description": "The display name of the alert.", + "readOnly": true, + "type": "string" + }, + "alertType": { + "description": "The type name of the alert.", + "readOnly": true, + "type": "string" + }, + "compromisedEntity": { + "description": "Display name of the main entity being reported on.", + "readOnly": true, + "type": "string" + }, + "confidenceLevel": { + "description": "The confidence level of this alert.", + "enum": [ + "Unknown", + "Low", + "High" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidenceLevel", + "values": [ + { + "description": "Unknown confidence, the is the default value", + "value": "Unknown" + }, + { + "description": "Low confidence, meaning we have some doubts this is indeed malicious or part of an attack", + "value": "Low" + }, + { + "description": "High confidence that the alert is true positive malicious", + "value": "High" + } + ] + } + }, + "confidenceReasons": { + "description": "The confidence reasons", + "items": { + "description": "confidence reason item", + "properties": { + "reason": { + "description": "The reason's description", + "readOnly": true, + "type": "string" + }, + "reasonType": { + "description": "The type (category) of the reason", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "confidenceScore": { + "description": "The confidence score of the alert.", + "format": "double", + "readOnly": true, + "type": "number" + }, + "confidenceScoreStatus": { + "description": "The confidence score calculation status, i.e. indicating if score calculation is pending for this alert, not applicable or final.", + "enum": [ + "NotApplicable", + "InProcess", + "NotFinal", + "Final" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConfidenceScoreStatus", + "values": [ + { + "description": "Score will not be calculated for this alert as it is not supported by virtual analyst", + "value": "NotApplicable" + }, + { + "description": "No score was set yet and calculation is in progress", + "value": "InProcess" + }, + { + "description": "Score is calculated and shown as part of the alert, but may be updated again at a later time following the processing of additional data", + "value": "NotFinal" + }, + { + "description": "Final score was calculated and available", + "value": "Final" + } + ] + } + }, + "description": { + "description": "Alert description.", + "readOnly": true, + "type": "string" + }, + "endTimeUtc": { + "description": "The impact end time of the alert (the time of the last event contributing to the alert).", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "intent": { + "description": "Holds the alert intent stage(s) mapping for this alert.", + "enum": [ + "Unknown", + "Probing", + "Exploitation", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Execution", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "KillChainIntent", + "values": [ + { + "description": "The default value.", + "value": "Unknown" + }, + { + "description": "Probing could be an attempt to access a certain resource regardless of a malicious intent or a failed attempt to gain access to a target system to gather information prior to exploitation. This step is usually detected as an attempt originating from outside the network in attempt to scan the target system and find a way in.", + "value": "Probing" + }, + { + "description": "Exploitation is the stage where an attacker manage to get foothold on the attacked resource. This stage is applicable not only for compute hosts, but also for resources such as user accounts, certificates etc. Adversaries will often be able to control the resource after this stage.", + "value": "Exploitation" + }, + { + "description": "Persistence is any access, action, or configuration change to a system that gives an adversary a persistent presence on that system. Adversaries will often need to maintain access to systems through interruptions such as system restarts, loss of credentials, or other failures that would require a remote access tool to restart or alternate backdoor for them to regain access.", + "value": "Persistence" + }, + { + "description": "Privilege escalation is the result of actions that allow an adversary to obtain a higher level of permissions on a system or network. Certain tools or actions require a higher level of privilege to work and are likely necessary at many points throughout an operation. User accounts with permissions to access specific systems or perform specific functions necessary for adversaries to achieve their objective may also be considered an escalation of privilege.", + "value": "PrivilegeEscalation" + }, + { + "description": "Defense evasion consists of techniques an adversary may use to evade detection or avoid other defenses. Sometimes these actions are the same as or variations of techniques in other categories that have the added benefit of subverting a particular defense or mitigation. ", + "value": "DefenseEvasion" + }, + { + "description": "Credential access represents techniques resulting in access to or control over system, domain, or service credentials that are used within an enterprise environment. Adversaries will likely attempt to obtain legitimate credentials from users or administrator accounts (local system administrator or domain users with administrator access) to use within the network. With sufficient access within a network, an adversary can create accounts for later use within the environment.", + "value": "CredentialAccess" + }, + { + "description": "Discovery consists of techniques that allow the adversary to gain knowledge about the system and internal network. When adversaries gain access to a new system, they must navigate themselves to what they now have control of and what benefits operating from that system give to their current objective or overall goals during the intrusion. The operating system provides many native tools that aid in this post-compromise information-gathering phase.", + "value": "Discovery" + }, + { + "description": "Lateral movement consists of techniques that enable an adversary to access and control remote systems on a network and could, but does not necessarily, include execution of tools on remote systems. The lateral movement techniques could allow an adversary to gather information from a system without needing additional tools, such as a remote access tool. An adversary can use lateral movement for many purposes, including remote Execution of tools, pivoting to additional systems, access to specific information or files, access to additional credentials, or to cause an effect.", + "value": "LateralMovement" + }, + { + "description": "The execution tactic represents techniques that result in execution of adversary-controlled code on a local or remote system. This tactic is often used in conjunction with lateral movement to expand access to remote systems on a network.", + "value": "Execution" + }, + { + "description": "Collection consists of techniques used to identify and gather information, such as sensitive files, from a target network prior to exfiltration. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Collection" + }, + { + "description": "Exfiltration refers to techniques and attributes that result or aid in the adversary removing files and information from a target network. This category also covers locations on a system or network where the adversary may look for information to exfiltrate.", + "value": "Exfiltration" + }, + { + "description": "The command and control tactic represents how adversaries communicate with systems under their control within a target network.", + "value": "CommandAndControl" + }, + { + "description": "The impact intent primary objective is to directly reduce the availability or integrity of a system, service, or network; including manipulation of data to impact a business or operational process. This would often refer to techniques such as ransom-ware, defacement, data manipulation and others.", + "value": "Impact" + } + ] + } + }, + "providerAlertId": { + "description": "The identifier of the alert inside the product which generated the alert.", + "readOnly": true, + "type": "string" + }, + "processingEndTime": { + "description": "The time the alert was made available for consumption.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "productComponentName": { + "description": "The name of a component inside the product which generated the alert.", + "readOnly": true, + "type": "string" + }, + "productName": { + "description": "The name of the product which published this alert.", + "readOnly": true, + "type": "string" + }, + "productVersion": { + "description": "The version of the product generating the alert.", + "readOnly": true, + "type": "string" + }, + "remediationSteps": { + "description": "Manual action items to take to remediate the alert.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "severity": { + "$ref": "AlertTypes.json#/definitions/AlertSeverityEnum", + "description": "The severity of the alert", + "type": "string" + }, + "startTimeUtc": { + "description": "The impact start time of the alert (the time of the first event contributing to the alert).", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "The lifecycle status of the alert.", + "enum": [ + "Unknown", + "New", + "Resolved", + "Dismissed", + "InProgress" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertStatus", + "values": [ + { + "description": "Unknown value", + "value": "Unknown" + }, + { + "description": "New alert", + "value": "New" + }, + { + "description": "Alert closed after handling", + "value": "Resolved" + }, + { + "description": "Alert dismissed as false positive", + "value": "Dismissed" + }, + { + "description": "Alert is being handled", + "value": "InProgress" + } + ] + } + }, + "systemAlertId": { + "description": "Holds the product identifier of the alert for the product.", + "readOnly": true, + "type": "string" + }, + "tactics": { + "description": "The tactics of the alert", + "items": { + "$ref": "AlertTypes.json#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + }, + "timeGenerated": { + "description": "The time the alert was generated.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "vendorName": { + "description": "The name of the vendor that raise the alert.", + "readOnly": true, + "type": "string" + }, + "alertLink": { + "description": "The uri link of the alert.", + "readOnly": true, + "type": "string" + }, + "resourceIdentifiers": { + "description": "The list of resource identifiers of the alert.", + "items": { + "type": "object" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + }, + "SecurityGroupEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a security group entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SecurityGroupEntityProperties", + "description": "SecurityGroup entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SecurityGroup" + }, + "SecurityGroupEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "SecurityGroup entity property bag.", + "properties": { + "distinguishedName": { + "description": "The group distinguished name", + "readOnly": true, + "type": "string" + }, + "objectGuid": { + "description": "A single-value attribute that is the unique identifier for the object, assigned by active directory.", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "sid": { + "description": "The SID attribute is a single-value attribute that specifies the security identifier (SID) of the group", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "SubmissionMailEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a submission mail entity.", + "properties": { + "properties": { + "$ref": "#/definitions/SubmissionMailEntityProperties", + "description": "Submission mail entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "SubmissionMail" + }, + "SubmissionMailEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Submission mail entity property bag.", + "properties": { + "networkMessageId": { + "description": "The network message id of email to which submission belongs", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "submissionId": { + "description": "The submission id", + "format": "uuid", + "readOnly": true, + "type": "string" + }, + "submitter": { + "description": "The submitter", + "readOnly": true, + "type": "string" + }, + "submissionDate": { + "description": "The submission date", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "timestamp": { + "description": "The Time stamp when the message is received (Mail)", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "recipient": { + "description": "The recipient of the mail", + "readOnly": true, + "type": "string" + }, + "sender": { + "description": "The sender of the mail", + "readOnly": true, + "type": "string" + }, + "senderIp": { + "description": "The sender's IP", + "readOnly": true, + "type": "string" + }, + "subject": { + "description": "The subject of submission mail", + "readOnly": true, + "type": "string" + }, + "reportType": { + "description": "The submission type for the given instance. This maps to Junk, Phish, Malware or NotJunk.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "UrlEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents a url entity.", + "properties": { + "properties": { + "$ref": "#/definitions/UrlEntityProperties", + "description": "Url entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Url" + }, + "UrlEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Url entity property bag.", + "properties": { + "url": { + "description": "A full URL the entity points to", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NicEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "description": "Represents an network interface entity.", + "properties": { + "properties": { + "$ref": "#/definitions/NicEntityProperties", + "description": "Network interface entity properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Nic" + }, + "NicEntityProperties": { + "allOf": [ + { + "$ref": "#/definitions/EntityCommonProperties" + } + ], + "description": "Nic entity property bag.", + "properties": { + "macAddress": { + "description": "The MAC address of this network interface", + "readOnly": true, + "type": "string" + }, + "ipAddressEntityId": { + "description": "The IP entity id of this network interface", + "readOnly": true, + "type": "string" + }, + "vlans": { + "description": "A list of VLANs of the network interface entity.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array", + "x-ms-identifiers": [] + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/IncidentTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/IncidentTypes.json new file mode 100644 index 000000000000..1e3fc46d942d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/IncidentTypes.json @@ -0,0 +1,246 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-05-01-preview", + "title": "Common Incident types" + }, + "paths": {}, + "definitions": { + "IncidentClassificationEnum": { + "description": "The reason the incident was closed", + "enum": [ + "Undetermined", + "TruePositive", + "BenignPositive", + "FalsePositive" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentClassification", + "values": [ + { + "description": "Incident classification was undetermined", + "value": "Undetermined" + }, + { + "description": "Incident was true positive", + "value": "TruePositive" + }, + { + "description": "Incident was benign positive", + "value": "BenignPositive" + }, + { + "description": "Incident was false positive", + "value": "FalsePositive" + } + ] + } + }, + "IncidentClassificationReasonEnum": { + "description": "The classification reason the incident was closed with", + "enum": [ + "SuspiciousActivity", + "SuspiciousButExpected", + "IncorrectAlertLogic", + "InaccurateData" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentClassificationReason", + "values": [ + { + "description": "Classification reason was suspicious activity", + "value": "SuspiciousActivity" + }, + { + "description": "Classification reason was suspicious but expected", + "value": "SuspiciousButExpected" + }, + { + "description": "Classification reason was incorrect alert logic", + "value": "IncorrectAlertLogic" + }, + { + "description": "Classification reason was inaccurate data", + "value": "InaccurateData" + } + ] + } + }, + "IncidentLabel": { + "description": "Represents an incident label", + "properties": { + "labelName": { + "description": "The name of the label", + "type": "string" + }, + "labelType": { + "$ref": "#/definitions/IncidentLabelType" + } + }, + "required": [ + "labelName" + ], + "type": "object" + }, + "IncidentLabelType": { + "description": "The type of the label", + "enum": [ + "User", + "AutoAssigned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentLabelType", + "values": [ + { + "description": "Label manually created by a user", + "value": "User" + }, + { + "description": "Label automatically created by the system", + "value": "AutoAssigned" + } + ] + } + }, + "IncidentSeverityEnum": { + "description": "The severity of the incident", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "IncidentStatusEnum": { + "description": "The status of the incident", + "enum": [ + "New", + "Active", + "Closed" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentStatus", + "values": [ + { + "description": "An active incident which isn't being handled currently", + "value": "New" + }, + { + "description": "An active incident which is being handled", + "value": "Active" + }, + { + "description": "A non-active incident", + "value": "Closed" + } + ] + } + }, + "IncidentOwnerInfo": { + "description": "Information on the user an incident is assigned to", + "properties": { + "email": { + "description": "The email of the user the incident is assigned to.", + "type": "string" + }, + "assignedTo": { + "description": "The name of the user the incident is assigned to.", + "type": "string" + }, + "objectId": { + "description": "The object id of the user the incident is assigned to.", + "format": "uuid", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name of the user the incident is assigned to.", + "type": "string" + }, + "ownerType": { + "description": "The type of the owner the incident is assigned to.", + "type": "string", + "enum": [ + "Unknown", + "User", + "Group" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "OwnerType", + "values": [ + { + "description": "The incident owner type is unknown", + "value": "Unknown" + }, + { + "description": "The incident owner type is an AAD user", + "value": "User" + }, + { + "description": "The incident owner type is an AAD group", + "value": "Group" + } + ] + } + } + }, + "type": "object" + }, + "IncidentInfo": { + "description": "Describes related incident information for the bookmark", + "properties": { + "incidentId": { + "description": "Incident Id", + "type": "string" + }, + "severity": { + "description": "The severity of the incident", + "type": "string", + "$ref": "#/definitions/IncidentSeverityEnum" + }, + "title": { + "description": "The title of the incident", + "type": "string" + }, + "relationName": { + "description": "Relation Name", + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/RelationTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/RelationTypes.json new file mode 100644 index 000000000000..d67ef6253edd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/RelationTypes.json @@ -0,0 +1,95 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-05-01-preview", + "title": "Common Relation types" + }, + "paths": {}, + "definitions": { + "RelationList": { + "description": "List of relations.", + "properties": { + "nextLink": { + "readOnly": true, + "description": "URL to fetch the next set of relations.", + "type": "string" + }, + "value": { + "description": "Array of relations.", + "type": "array", + "items": { + "$ref": "#/definitions/Relation" + } + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "Relation": { + "type": "object", + "description": "Represents a relation between two resources", + "allOf": [ + { + "$ref": "../../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/RelationProperties", + "description": "Relation properties", + "x-ms-client-flatten": true + } + } + }, + "RelationProperties": { + "description": "Relation property bag.", + "properties": { + "relatedResourceId": { + "description": "The resource ID of the related resource", + "type": "string" + }, + "relatedResourceName": { + "description": "The name of the related resource", + "readOnly": true, + "type": "string" + }, + "relatedResourceType": { + "description": "The resource type of the related resource", + "readOnly": true, + "type": "string" + }, + "relatedResourceKind": { + "description": "The resource kind of the related resource", + "readOnly": true, + "type": "string" + } + }, + "required": [ + "relatedResourceId" + ], + "type": "object" + } + }, + "parameters": { + "RelationName": { + "name": "relationName", + "in": "path", + "required": true, + "type": "string", + "description": "Relation Name", + "x-ms-parameter-location": "method" + }, + "Relation": { + "name": "relation", + "in": "body", + "description": "The relation model", + "required": true, + "schema": { + "$ref": "#/definitions/Relation" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/ThreatIntelligenceTypes.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/ThreatIntelligenceTypes.json new file mode 100644 index 000000000000..266b55f0e87e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/common/ThreatIntelligenceTypes.json @@ -0,0 +1,48 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-05-01-preview", + "title": "Common Relation types" + }, + "paths": {}, + "definitions": { + "ThreatIntelligence": { + "description": "ThreatIntelligence property bag.", + "properties": { + "confidence": { + "description": "Confidence (must be between 0 and 1)", + "format": "double", + "readOnly": true, + "type": "number" + }, + "providerName": { + "description": "Name of the provider from whom this Threat Intelligence information was received", + "readOnly": true, + "type": "string" + }, + "reportLink": { + "description": "Report link", + "readOnly": true, + "type": "string" + }, + "threatDescription": { + "description": "Threat description (free text)", + "readOnly": true, + "type": "string" + }, + "threatName": { + "description": "Threat name (e.g. \"Jedobot malware\")", + "readOnly": true, + "type": "string" + }, + "threatType": { + "description": "Threat type (e.g. \"Botnet\")", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/dataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/dataConnectors.json new file mode 100644 index 000000000000..08e41c92e2ea --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/dataConnectors.json @@ -0,0 +1,3118 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors": { + "get": { + "x-ms-examples": { + "Get all data connectors.": { + "$ref": "./examples/dataConnectors/GetDataConnectors.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Gets all data connectors.", + "operationId": "DataConnectors_List", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/DataConnectorList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}": { + "get": { + "x-ms-examples": { + "Get an Office365 data connector.": { + "$ref": "./examples/dataConnectors/GetOfficeDataConnetorById.json" + }, + "Get a TI data connector": { + "$ref": "./examples/dataConnectors/GetThreatIntelligenceById.json" + }, + "Get a TI Taxii data connector.": { + "$ref": "./examples/dataConnectors/GetThreatIntelligenceTaxiiById.json" + }, + "Get a MCAS data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json" + }, + "Get a ASC data connector": { + "$ref": "./examples/dataConnectors/GetAzureSecurityCenterById.json" + }, + "Get an AADIP (Azure Active Directory Identity Protection) data connector": { + "$ref": "./examples/dataConnectors/GetAzureActiveDirectoryById.json" + }, + "Get an AwsCloudTrail data connector": { + "$ref": "./examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json" + }, + "Get an Aws S3 data connector": { + "$ref": "./examples/dataConnectors/GetAmazonWebServicesS3ById.json" + }, + "Get an AATP data connector": { + "$ref": "./examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json" + }, + "Get a MDATP data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json" + }, + "Get an Office ATP data connector": { + "$ref": "./examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json" + }, + "Get an Office IRM data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json" + }, + "Get an Office365 Project data connector": { + "$ref": "./examples/dataConnectors/GetOffice365ProjectDataConnetorById.json" + }, + "Get a MicrosoftPurviewInformationProtection data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json" + }, + "Get an Office365 PowerBI data connector": { + "$ref": "./examples/dataConnectors/GetOfficePowerBIDataConnetorById.json" + }, + "Get a Dynamics365 data connector": { + "$ref": "./examples/dataConnectors/GetDynamics365DataConnectorById.json" + }, + "Get a MicrosoftThreatProtection data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftThreatProtectionById.json" + }, + "Get a MicrosoftThreatIntelligence data connector": { + "$ref": "./examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json" + }, + "Get a GenericUI data connector": { + "$ref": "./examples/dataConnectors/GetGenericUI.json" + }, + "Get a APIPolling data connector": { + "$ref": "./examples/dataConnectors/GetAPIPolling.json" + }, + "Get a IoT data connector": { + "$ref": "./examples/dataConnectors/GetIoTById.json" + }, + "Get a GCP data connector": { + "$ref": "./examples/dataConnectors/GetGoogleCloudPlatformById.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Gets a data connector.", + "operationId": "DataConnectors_Get", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an Office365 data connector": { + "$ref": "./examples/dataConnectors/CreateOfficeDataConnetor.json" + }, + "Creates or updates an Office365 Project data connector": { + "$ref": "./examples/dataConnectors/CreateOffice365ProjectDataConnetor.json" + }, + "Creates or updates an MicrosoftPurviewInformationProtection data connector": { + "$ref": "./examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json" + }, + "Creates or updates a Microsoft Threat Intelligence data connector.": { + "$ref": "./examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json" + }, + "Creates or updates an Office PowerBI data connector": { + "$ref": "./examples/dataConnectors/CreateOfficePowerBIDataConnector.json" + }, + "Creates or updates a Threat Intelligence Taxii data connector.": { + "$ref": "./examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json" + }, + "Creates or updates an Threat Intelligence Platform data connector": { + "$ref": "./examples/dataConnectors/CreateThreatIntelligenceDataConnector.json" + }, + "Creates or updates a Dynamics365 data connector.": { + "$ref": "./examples/dataConnectors/CreateDynamics365DataConnetor.json" + }, + "Creates or updates a GenericUI data connector": { + "$ref": "./examples/dataConnectors/CreateGenericUI.json" + }, + "Creates or updates a APIPolling data connector": { + "$ref": "./examples/dataConnectors/CreateAPIPolling.json" + }, + "Creates or updates a MicrosoftThreatProtection data connector": { + "$ref": "./examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json" + }, + "Creates or updates a GCP data connector": { + "$ref": "./examples/dataConnectors/CreateGoogleCloudPlatform.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Creates or updates the data connector.", + "operationId": "DataConnectors_CreateOrUpdate", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + }, + { + "$ref": "#/parameters/DataConnector" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataConnector" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an Office365 data connector": { + "$ref": "./examples/dataConnectors/DeleteOfficeDataConnetor.json" + }, + "Delete an Office365 Project data connector": { + "$ref": "./examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json" + }, + "Delete an MicrosoftPurviewInformationProtection data connector": { + "$ref": "./examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json" + }, + "Delete an MicrosoftThreatIntelligence data connector": { + "$ref": "./examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json" + }, + "Delete an Office PowerBI data connector": { + "$ref": "./examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json" + }, + "Delete a GenericUI data connector": { + "$ref": "./examples/dataConnectors/DeleteGenericUI.json" + }, + "Delete a APIPolling data connector": { + "$ref": "./examples/dataConnectors/DeleteAPIPolling.json" + }, + "Delete a GCP data connector": { + "$ref": "./examples/dataConnectors/DeleteGoogleCloudPlatform.json" + } + }, + "tags": [ + "Data Connectors" + ], + "description": "Delete the data connector.", + "operationId": "DataConnectors_Delete", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}/connect": { + "post": { + "x-ms-examples": { + "Connect an APIPolling data connector": { + "$ref": "./examples/dataConnectors/ConnectAPIPolling.json" + }, + "Connect an APIPolling V2 logs data connector": { + "$ref": "./examples/dataConnectors/ConnectAPIPollingV2Logs.json" + } + }, + "tags": [ + "Data Connectors Connect" + ], + "description": "Connects a data connector.", + "operationId": "DataConnectors_Connect", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + }, + { + "$ref": "#/parameters/DataConnectorConnectBody" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectors/{dataConnectorId}/disconnect": { + "post": { + "x-ms-examples": { + "Disconnect an APIPolling data connector": { + "$ref": "./examples/dataConnectors/DisconnectAPIPolling.json" + } + }, + "tags": [ + "Data Connectors Disconnect" + ], + "description": "Disconnect a data connector.", + "operationId": "DataConnectors_Disconnect", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/dataConnectorsCheckRequirements": { + "post": { + "x-ms-examples": { + "Check requirements for TI.": { + "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligence.json" + }, + "Check requirements for TI Taxii.": { + "$ref": "./examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json" + }, + "Check requirements for AADIP (Azure Active Directory Identity Protection).": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json" + }, + "Check requirements for AADIP (Azure Active Directory Identity Protection) - no license.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json" + }, + "Check requirements for AADIP (Azure Active Directory Identity Protection) - no authorization.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json" + }, + "Check requirements for ASC.": { + "$ref": "./examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json" + }, + "Check requirements for Mcas.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json" + }, + "Check requirements for Mdatp.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMdatp.json" + }, + "Check requirements for OfficeATP.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOfficeATP.json" + }, + "Check requirements for OfficeIRM.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOfficeIRM.json" + }, + "Check requirements for Office365Project.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOffice365Project.json" + }, + "Check requirements for MicrosoftPurviewInformationProtection.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json" + }, + "Check requirements for OfficePowerBI.": { + "$ref": "./examples/dataConnectors/CheckRequirementsOfficePowerBI.json" + }, + "Check requirements for Dynamics365.": { + "$ref": "./examples/dataConnectors/CheckRequirementsDynamics365.json" + }, + "Check requirements for MicrosoftThreatProtection.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json" + }, + "Check requirements for MicrosoftThreatIntelligence.": { + "$ref": "./examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json" + }, + "Check requirements for IoT.": { + "$ref": "./examples/dataConnectors/CheckRequirementsIoT.json" + } + }, + "tags": [ + "Check Data Connector Requirements" + ], + "description": "Get requirements state for a data connector type.", + "operationId": "DataConnectorsCheckRequirements_Post", + "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": "../../../common/2.0/types.json#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/DataConnectorsCheckRequirementsBody" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataConnectorRequirementsState" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AADCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents AADIP (Azure Active Directory Identity Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/AADCheckRequirementsProperties", + "description": "AADIP (Azure Active Directory Identity Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "AADCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "AADIP (Azure Active Directory Identity Protection) requirements check properties.", + "type": "object" + }, + "AATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents AATP (Azure Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/AATPCheckRequirementsProperties", + "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureAdvancedThreatProtection" + }, + "AATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "AATP (Azure Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "ASCCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents ASC (Azure Security Center) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/ASCCheckRequirementsProperties", + "description": "ASC (Azure Security Center) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureSecurityCenter" + }, + "ASCCheckRequirementsProperties": { + "description": "ASC (Azure Security Center) requirements check properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "AwsCloudTrailCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Amazon Web Services CloudTrail requirements check request.", + "type": "object", + "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" + }, + "AwsS3CheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Amazon Web Services S3 requirements check request.", + "type": "object", + "x-ms-discriminator-value": "AmazonWebServicesS3" + }, + "DataConnectorsCheckRequirements": { + "description": "Data connector requirements properties.", + "properties": { + "kind": { + "$ref": "#/definitions/DataConnectorKind", + "description": "Describes the kind of connector to be checked.", + "type": "string" + } + }, + "discriminator": "kind", + "type": "object", + "required": [ + "kind" + ] + }, + "DataConnectorAuthorizationState": { + "description": "Describes the state of user's authorization for a connector kind.", + "enum": [ + "Valid", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorAuthorizationState", + "values": [ + { + "value": "Valid" + }, + { + "value": "Invalid" + } + ] + } + }, + "DataConnectorLicenseState": { + "description": "Describes the state of user's license for a connector kind.", + "enum": [ + "Valid", + "Invalid", + "Unknown" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorLicenseState", + "values": [ + { + "value": "Valid" + }, + { + "value": "Invalid" + }, + { + "value": "Unknown" + } + ] + } + }, + "DataConnectorRequirementsState": { + "description": "Data connector requirements status.", + "properties": { + "authorizationState": { + "description": "Authorization state for this connector", + "$ref": "#/definitions/DataConnectorAuthorizationState" + }, + "licenseState": { + "description": "License state for this connector", + "$ref": "#/definitions/DataConnectorLicenseState" + } + }, + "type": "object" + }, + "Dynamics365CheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Dynamics365 requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/Dynamics365CheckRequirementsProperties", + "description": "Dynamics365 requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Dynamics365" + }, + "Dynamics365CheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Dynamics365 requirements check properties.", + "type": "object" + }, + "MCASCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MCAS (Microsoft Cloud App Security) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MCASCheckRequirementsProperties", + "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" + }, + "MCASCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MCAS (Microsoft Cloud App Security) requirements check properties.", + "type": "object" + }, + "MDATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MDATPCheckRequirementsProperties", + "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" + }, + "MDATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MDATP (Microsoft Defender Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "MSTICheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Microsoft Threat Intelligence requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MSTICheckRequirementsProperties", + "description": "Microsoft Threat Intelligence requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatIntelligence" + }, + "MSTICheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Microsoft Threat Intelligence requirements check properties.", + "type": "object" + }, + "MtpCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MTP (Microsoft Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MTPCheckRequirementsProperties", + "description": "MTP (Microsoft Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatProtection" + }, + "MTPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MTP (Microsoft Threat Protection) requirements check properties.", + "type": "object" + }, + "OfficeATPCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeATPCheckRequirementsProperties", + "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeATP" + }, + "OfficeATPCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "OfficeATP (Office 365 Advanced Threat Protection) requirements check properties.", + "type": "object" + }, + "OfficeIRMCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents OfficeIRM (Microsoft Insider Risk Management) requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeIRMCheckRequirementsProperties", + "description": "OfficeIRM (Microsoft Insider Risk Management) requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeIRM" + }, + "OfficeIRMCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "OfficeIRM (Microsoft Insider Risk Management) requirements check properties.", + "type": "object" + }, + "MicrosoftPurviewInformationProtectionCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents MicrosoftPurviewInformationProtection requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftPurviewInformationProtectionCheckRequirementsProperties", + "description": "MicrosoftPurviewInformationProtection requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftPurviewInformationProtection" + }, + "MicrosoftPurviewInformationProtectionCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MicrosoftPurviewInformationProtection requirements check properties.", + "type": "object" + }, + "Office365ProjectCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Office365 Project requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/Office365ProjectCheckRequirementsProperties", + "description": "Office365 Project requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Office365Project" + }, + "Office365ProjectCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office365 Project requirements check properties.", + "type": "object" + }, + "OfficePowerBICheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents Office PowerBI requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficePowerBICheckRequirementsProperties", + "description": "Office Power BI requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficePowerBI" + }, + "OfficePowerBICheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office PowerBI requirements check properties.", + "type": "object" + }, + "TICheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Threat Intelligence Platforms data connector check requirements", + "properties": { + "properties": { + "$ref": "#/definitions/TICheckRequirementsProperties", + "description": "Threat Intelligence Platforms data connector check required properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "TICheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence Platforms data connector required properties.", + "properties": {}, + "type": "object" + }, + "TiTaxiiCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Threat Intelligence TAXII data connector check requirements", + "properties": { + "properties": { + "$ref": "#/definitions/TiTaxiiCheckRequirementsProperties", + "description": "Threat Intelligence TAXII check required properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligenceTaxii" + }, + "TiTaxiiCheckRequirementsProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence TAXII data connector required properties.", + "type": "object" + }, + "IoTCheckRequirements": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + } + ], + "description": "Represents IoT requirements check request.", + "properties": { + "properties": { + "$ref": "#/definitions/IoTCheckRequirementsProperties", + "description": "IoT requirements check properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "IOT" + }, + "IoTCheckRequirementsProperties": { + "description": "IoT requirements check properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "AADDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents AADIP (Azure Active Directory Identity Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AADDataConnectorProperties", + "description": "AADIP (Azure Active Directory Identity Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "AADDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "AADIP (Azure Active Directory Identity Protection) data connector properties.", + "type": "object" + }, + "AlertsDataTypeOfDataConnector": { + "description": "Alerts data type for data connectors.", + "properties": { + "alerts": { + "$ref": "#/definitions/DataConnectorDataTypeCommon", + "description": "Alerts data type connection.", + "type": "object" + } + }, + "type": "object", + "required": [ + "alerts" + ] + }, + "MSTIDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Microsoft Threat Intelligence data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MSTIDataConnectorProperties", + "description": "Microsoft Threat Intelligence data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatIntelligence" + }, + "MSTIDataConnectorDataTypes": { + "description": "The available data types for Microsoft Threat Intelligence Platforms data connector.", + "properties": { + "microsoftEmergingThreatFeed": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "properties": { + "lookbackPeriod": { + "description": "The lookback period for the feed to be imported.", + "type": "string" + } + }, + "description": "Data type for Microsoft Threat Intelligence Platforms data connector.", + "type": "object", + "required": [ + "lookbackPeriod" + ] + } + }, + "type": "object", + "required": [ + "microsoftEmergingThreatFeed" + ] + }, + "MSTIDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Microsoft Threat Intelligence data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/MSTIDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "MTPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents MTP (Microsoft Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MTPDataConnectorProperties", + "description": "MTP (Microsoft Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftThreatProtection" + }, + "MTPDataConnectorDataTypes": { + "description": "The available data types for Microsoft Threat Protection Platforms data connector.", + "properties": { + "incidents": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Incidents data type for Microsoft Threat Protection Platforms data connector.", + "type": "object" + }, + "alerts": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Alerts data type for Microsoft Threat Protection Platforms data connector.", + "type": "object" + } + }, + "type": "object", + "required": [ + "incidents" + ] + }, + "MtpProvider": { + "description": "The available data providers.", + "enum": [ + "microsoftDefenderForCloudApps", + "microsoftDefenderForIdentity" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MtpProvider" + } + }, + "MtpFilteredProviders": { + "description": "Represents the connector's Filtered providers", + "properties": { + "alerts": { + "description": "Alerts filtered providers. When filters are not applied, all alerts will stream through the MTP pipeline, still in private preview for all products EXCEPT MDA and MDI, which are in GA state.", + "items": { + "$ref": "#/definitions/MtpProvider" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "alerts" + ] + }, + "MTPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MTP (Microsoft Threat Protection) data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/MTPDataConnectorDataTypes", + "description": "The available data types for the connector." + }, + "filteredProviders": { + "$ref": "#/definitions/MtpFilteredProviders", + "description": "The available filtered providers for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "AATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents AATP (Azure Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AATPDataConnectorProperties", + "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureAdvancedThreatProtection" + }, + "AATPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "type": "object" + }, + "ASCDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents ASC (Azure Security Center) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/ASCDataConnectorProperties", + "description": "ASC (Azure Security Center) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureSecurityCenter" + }, + "ASCDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "ASC (Azure Security Center) data connector properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "AwsCloudTrailDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Amazon Web Services CloudTrail data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AwsCloudTrailDataConnectorProperties", + "description": "Amazon Web Services CloudTrail data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" + }, + "AwsCloudTrailDataConnectorDataTypes": { + "description": "The available data types for Amazon Web Services CloudTrail data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object", + "required": [ + "logs" + ] + }, + "AwsCloudTrailDataConnectorProperties": { + "description": "Amazon Web Services CloudTrail data connector properties.", + "properties": { + "awsRoleArn": { + "description": "The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/AwsCloudTrailDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "dataTypes" + ] + }, + "AwsS3DataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Amazon Web Services S3 data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AwsS3DataConnectorProperties", + "description": "Amazon Web Services S3 data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AmazonWebServicesS3" + }, + "AwsS3DataConnectorDataTypes": { + "description": "The available data types for Amazon Web Services S3 data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object", + "required": [ + "logs" + ] + }, + "AwsS3DataConnectorProperties": { + "description": "Amazon Web Services S3 data connector properties.", + "properties": { + "destinationTable": { + "description": "The logs destination table name in LogAnalytics.", + "type": "string" + }, + "sqsUrls": { + "description": "The AWS sqs urls for the connector.", + "x-ms-identifiers": [], + "type": "array", + "items": { + "description": "AWS sqs url.", + "type": "string" + } + }, + "roleArn": { + "description": "The Aws Role Arn that is used to access the Aws account.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/AwsS3DataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "destinationTable", + "sqsUrls", + "roleArn", + "dataTypes" + ] + }, + "GCPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Google Cloud Platform data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/GCPDataConnectorProperties", + "description": "Google Cloud Platform data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "GCP" + }, + "GCPDataConnectorProperties": { + "description": "Google Cloud Platform data connector properties.", + "properties": { + "connectorDefinitionName": { + "description": "The name of the connector definition that represents the UI config.", + "type": "string" + }, + "auth": { + "$ref": "#/definitions/GCPAuthProperties", + "description": "The auth section of the connector." + }, + "request": { + "$ref": "#/definitions/GCPRequestProperties", + "description": "The request section of the connector." + }, + "dcrConfig": { + "$ref": "#/definitions/DCRConfiguration", + "description": "The configuration of the destination of the data." + } + }, + "type": "object", + "required": [ + "connectorDefinitionName", + "auth", + "request" + ] + }, + "GCPAuthProperties": { + "description": "Google Cloud Platform auth section properties.", + "properties": { + "serviceAccountEmail": { + "description": "The service account that is used to access the GCP project.", + "type": "string" + }, + "projectNumber": { + "description": "The GCP project number.", + "type": "string" + }, + "workloadIdentityProviderId": { + "description": "The workload identity provider id that is used to gain access to the GCP project.", + "type": "string" + } + }, + "type": "object", + "required": [ + "serviceAccountEmail", + "projectNumber", + "workloadIdentityProviderId" + ] + }, + "GCPRequestProperties": { + "description": "Google Cloud Platform request section properties.", + "properties": { + "projectId": { + "description": "The GCP project id.", + "type": "string" + }, + "subscriptionNames": { + "description": "The GCP pub/sub subscription names.", + "x-ms-identifiers": [], + "type": "array", + "items": { + "description": "GCP pub/sub subscription name.", + "type": "string" + } + } + }, + "type": "object", + "required": [ + "projectId", + "subscriptionNames" + ] + }, + "DCRConfiguration": { + "description": "The configuration of the destination of the data.", + "properties": { + "dataCollectionEndpoint": { + "description": "Represents the data collection ingestion endpoint in log analytics.", + "type": "string" + }, + "dataCollectionRuleImmutableId": { + "description": "The data collection rule immutable id, the rule defines the transformation and data destination.", + "type": "string" + }, + "streamName": { + "description": "The stream we are sending the data to.", + "type": "string" + } + }, + "type": "object", + "required": [ + "dataCollectionEndpoint", + "dataCollectionRuleImmutableId", + "streamName" + ] + }, + "DataConnector": { + "description": "Data connector", + "allOf": [ + { + "$ref": "../../../common/2.0/types.json#/definitions/ResourceWithEtag" + } + ], + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/DataConnectorKind", + "description": "The data connector kind", + "type": "string" + } + }, + "type": "object" + }, + "DataConnectorDataTypeCommon": { + "description": "Common field for data type in data connectors.", + "properties": { + "state": { + "description": "Describe whether this data type connection is enabled or not.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataTypeState" + } + } + }, + "type": "object", + "required": [ + "state" + ] + }, + "DataConnectorWithAlertsProperties": { + "description": "Data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "DataConnectorKind": { + "description": "The kind of the data connector", + "enum": [ + "AzureActiveDirectory", + "AzureSecurityCenter", + "MicrosoftCloudAppSecurity", + "ThreatIntelligence", + "ThreatIntelligenceTaxii", + "Office365", + "OfficeATP", + "OfficeIRM", + "Office365Project", + "MicrosoftPurviewInformationProtection", + "OfficePowerBI", + "AmazonWebServicesCloudTrail", + "AmazonWebServicesS3", + "AzureAdvancedThreatProtection", + "MicrosoftDefenderAdvancedThreatProtection", + "Dynamics365", + "MicrosoftThreatProtection", + "MicrosoftThreatIntelligence", + "GenericUI", + "APIPolling", + "IOT", + "GCP" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorKind", + "values": [ + { + "value": "AzureActiveDirectory" + }, + { + "value": "AzureSecurityCenter" + }, + { + "value": "MicrosoftCloudAppSecurity" + }, + { + "value": "ThreatIntelligence" + }, + { + "value": "ThreatIntelligenceTaxii" + }, + { + "value": "Office365" + }, + { + "value": "OfficeATP" + }, + { + "value": "OfficeIRM" + }, + { + "value": "Office365Project" + }, + { + "value": "MicrosoftPurviewInformationProtection" + }, + { + "value": "OfficePowerBI" + }, + { + "value": "AmazonWebServicesCloudTrail" + }, + { + "value": "AmazonWebServicesS3" + }, + { + "value": "AzureAdvancedThreatProtection" + }, + { + "value": "MicrosoftDefenderAdvancedThreatProtection" + }, + { + "value": "Dynamics365" + }, + { + "value": "MicrosoftThreatProtection" + }, + { + "value": "MicrosoftThreatIntelligence" + }, + { + "value": "GenericUI" + }, + { + "value": "APIPolling" + }, + { + "value": "IOT" + }, + { + "value": "GCP" + } + ] + } + }, + "DataConnectorList": { + "description": "List all the data connectors.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of data connectors.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of data connectors.", + "items": { + "$ref": "#/definitions/DataConnector" + }, + "type": "array" + } + }, + "type": "object", + "required": [ + "value" + ] + }, + "DataConnectorTenantId": { + "description": "Properties data connector on tenant level.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object", + "required": [ + "tenantId" + ] + }, + "MCASDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents MCAS (Microsoft Cloud App Security) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MCASDataConnectorProperties", + "description": "MCAS (Microsoft Cloud App Security) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftCloudAppSecurity" + }, + "MCASDataConnectorDataTypes": { + "allOf": [ + { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector" + } + ], + "description": "The available data types for MCAS (Microsoft Cloud App Security) data connector.", + "properties": { + "discoveryLogs": { + "$ref": "#/definitions/DataConnectorDataTypeCommon", + "description": "Discovery log data type connection." + } + }, + "type": "object" + }, + "MCASDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "MCAS (Microsoft Cloud App Security) data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/MCASDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "Dynamics365DataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Dynamics365 data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/Dynamics365DataConnectorProperties", + "description": "Dynamics365 data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Dynamics365" + }, + "Dynamics365DataConnectorDataTypes": { + "description": "The available data types for Dynamics365 data connector.", + "properties": { + "dynamics365CdsActivities": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Common Data Service data type connection.", + "type": "object" + } + }, + "type": "object", + "required": [ + "dynamics365CdsActivities" + ] + }, + "Dynamics365DataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Dynamics365 data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/Dynamics365DataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "OfficeATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents OfficeATP (Office 365 Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeATPDataConnectorProperties", + "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeATP" + }, + "OfficeATPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "OfficeATP (Office 365 Advanced Threat Protection) data connector properties.", + "type": "object" + }, + "MicrosoftPurviewInformationProtectionDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Microsoft Purview Information Protection data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MicrosoftPurviewInformationProtectionDataConnectorProperties", + "description": "Microsoft Purview Information Protection data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftPurviewInformationProtection" + }, + "MicrosoftPurviewInformationProtectionConnectorDataTypes": { + "description": "The available data types for Microsoft Purview Information Protection data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object", + "required": [ + "logs" + ] + }, + "MicrosoftPurviewInformationProtectionDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Microsoft Purview Information Protection data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/MicrosoftPurviewInformationProtectionConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "dataTypes" + ] + }, + "Office365ProjectDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Office Microsoft Project data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/Office365ProjectDataConnectorProperties", + "description": "Office Microsoft Project data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Office365Project" + }, + "Office365ProjectConnectorDataTypes": { + "description": "The available data types for Office Microsoft Project data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object", + "required": [ + "logs" + ] + }, + "Office365ProjectDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office Microsoft Project data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/Office365ProjectConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "dataTypes" + ] + }, + "OfficePowerBIDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Office Microsoft PowerBI data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficePowerBIDataConnectorProperties", + "description": "Office Microsoft PowerBI data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficePowerBI" + }, + "OfficePowerBIConnectorDataTypes": { + "description": "The available data types for Office Microsoft PowerBI data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" + } + }, + "type": "object", + "required": [ + "logs" + ] + }, + "OfficePowerBIDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office Microsoft PowerBI data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/OfficePowerBIConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "dataTypes" + ] + }, + "OfficeIRMDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents OfficeIRM (Microsoft Insider Risk Management) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeIRMDataConnectorProperties", + "description": "OfficeIRM (Microsoft Insider Risk Management) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "OfficeIRM" + }, + "OfficeIRMDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "OfficeIRM (Microsoft Insider Risk Management) data connector properties.", + "type": "object" + }, + "MDATPDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents MDATP (Microsoft Defender Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/MDATPDataConnectorProperties", + "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" + }, + "MDATPDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + }, + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + "type": "object" + }, + "OfficeDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents office data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/OfficeDataConnectorProperties", + "description": "Office data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Office365" + }, + "OfficeDataConnectorDataTypes": { + "description": "The available data types for office data connector.", + "properties": { + "exchange": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Exchange data type connection.", + "type": "object" + }, + "sharePoint": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "SharePoint data type connection.", + "type": "object" + }, + "teams": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Teams data type connection.", + "type": "object" + } + }, + "required": [ + "exchange", + "sharePoint", + "teams" + ], + "type": "object" + }, + "OfficeDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Office data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/OfficeDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "required": [ + "dataTypes" + ], + "type": "object" + }, + "TIDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents threat intelligence data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/TIDataConnectorProperties", + "description": "TI (Threat Intelligence) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligence" + }, + "TIDataConnectorDataTypes": { + "description": "The available data types for TI (Threat Intelligence) data connector.", + "properties": { + "indicators": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Data type for indicators connection.", + "type": "object" + } + }, + "type": "object", + "required": [ + "indicators" + ] + }, + "TIDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "TI (Threat Intelligence) data connector properties.", + "properties": { + "tipLookbackPeriod": { + "description": "The lookback period for the feed to be imported.", + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "dataTypes": { + "$ref": "#/definitions/TIDataConnectorDataTypes", + "description": "The available data types for the connector." + } + }, + "type": "object", + "required": [ + "dataTypes" + ] + }, + "TiTaxiiDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Data connector to pull Threat intelligence data from TAXII 2.0/2.1 server", + "properties": { + "properties": { + "$ref": "#/definitions/TiTaxiiDataConnectorProperties", + "description": "Threat intelligence TAXII data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "ThreatIntelligenceTaxii" + }, + "TiTaxiiDataConnectorDataTypes": { + "description": "The available data types for Threat Intelligence TAXII data connector.", + "properties": { + "taxiiClient": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Data type for TAXII connector.", + "type": "object" + } + }, + "type": "object", + "required": [ + "taxiiClient" + ] + }, + "TiTaxiiDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorTenantId" + } + ], + "description": "Threat Intelligence TAXII data connector properties.", + "properties": { + "workspaceId": { + "description": "The workspace id.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for the TAXII server.", + "type": "string" + }, + "taxiiServer": { + "description": "The API root for the TAXII server.", + "type": "string" + }, + "collectionId": { + "description": "The collection id of the TAXII server.", + "type": "string" + }, + "userName": { + "description": "The userName for the TAXII server.", + "type": "string" + }, + "password": { + "description": "The password for the TAXII server.", + "type": "string" + }, + "taxiiLookbackPeriod": { + "description": "The lookback period for the TAXII server.", + "format": "date-time", + "type": "string", + "x-nullable": true + }, + "pollingFrequency": { + "description": "The polling frequency for the TAXII server.", + "type": "string", + "x-nullable": true, + "enum": [ + "OnceAMinute", + "OnceAnHour", + "OnceADay" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PollingFrequency", + "values": [ + { + "description": "Once a minute", + "value": "OnceAMinute" + }, + { + "description": "Once an hour", + "value": "OnceAnHour" + }, + { + "description": "Once a day", + "value": "OnceADay" + } + ] + } + }, + "dataTypes": { + "$ref": "#/definitions/TiTaxiiDataConnectorDataTypes", + "description": "The available data types for Threat Intelligence TAXII data connector." + } + }, + "required": [ + "dataTypes", + "pollingFrequency" + ], + "type": "object" + }, + "IoTDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents IoT data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/IoTDataConnectorProperties", + "description": "IoT data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "IOT" + }, + "IoTDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "IoT data connector properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "CodelessUiDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Codeless UI data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/CodelessParameters", + "description": "Codeless UI data connector properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "GenericUI" + }, + "CodelessParameters": { + "description": "Represents Codeless UI data connector", + "type": "object", + "properties": { + "connectorUiConfig": { + "$ref": "#/definitions/CodelessUiConnectorConfigProperties", + "description": "Config to describe the instructions blade" + } + } + }, + "CodelessUiConnectorConfigProperties": { + "description": "Config to describe the instructions blade", + "type": "object", + "properties": { + "title": { + "description": "Connector blade title", + "type": "string" + }, + "publisher": { + "description": "Connector publisher name", + "type": "string" + }, + "descriptionMarkdown": { + "description": "Connector description", + "type": "string" + }, + "customImage": { + "description": "An optional custom image to be used when displaying the connector within Azure Sentinel's connector's gallery", + "type": "string" + }, + "graphQueriesTableName": { + "description": "Name of the table the connector will insert the data to", + "type": "string" + }, + "graphQueries": { + "description": "The graph query to show the current data status", + "x-ms-identifiers": [], + "items": { + "allOf": [ + { + "$ref": "#/definitions/GraphQueries" + } + ] + }, + "type": "array" + }, + "sampleQueries": { + "description": "The sample queries for the connector", + "x-ms-identifiers": [], + "items": { + "allOf": [ + { + "$ref": "#/definitions/SampleQueries" + } + ] + }, + "type": "array" + }, + "dataTypes": { + "description": "Data types to check for last data received", + "x-ms-identifiers": [], + "items": { + "allOf": [ + { + "$ref": "#/definitions/LastDataReceivedDataType" + } + ] + }, + "type": "array" + }, + "connectivityCriteria": { + "description": "Define the way the connector check connectivity", + "x-ms-identifiers": [], + "items": { + "allOf": [ + { + "$ref": "#/definitions/ConnectivityCriteria" + } + ] + }, + "type": "array" + }, + "availability": { + "description": "Connector Availability Status", + "$ref": "#/definitions/Availability" + }, + "permissions": { + "description": "Permissions required for the connector", + "$ref": "#/definitions/Permissions" + }, + "instructionSteps": { + "description": "Instruction steps to enable the connector", + "x-ms-identifiers": [], + "items": { + "allOf": [ + { + "$ref": "#/definitions/InstructionSteps" + } + ] + }, + "type": "array" + } + }, + "required": [ + "title", + "publisher", + "descriptionMarkdown", + "graphQueriesTableName", + "graphQueries", + "sampleQueries", + "dataTypes", + "connectivityCriteria", + "availability", + "permissions", + "instructionSteps" + ] + }, + "DataConnectorConnectBody": { + "description": "Represents Codeless API Polling data connector.", + "type": "object", + "x-ms-identifiers": [], + "properties": { + "kind": { + "description": "The authentication kind used to poll the data", + "enum": [ + "Basic", + "OAuth2", + "APIKey" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConnectAuthKind" + } + }, + "apiKey": { + "type": "string", + "description": "The API key of the audit server." + }, + "dataCollectionEndpoint": { + "type": "string", + "description": "Used in v2 logs connector. Represents the data collection ingestion endpoint in log analytics." + }, + "dataCollectionRuleImmutableId": { + "type": "string", + "description": "Used in v2 logs connector. The data collection rule immutable id, the rule defines the transformation and data destination." + }, + "outputStream": { + "type": "string", + "description": "Used in v2 logs connector. The stream we are sending the data to, this is the name of the streamDeclarations defined in the DCR." + }, + "clientSecret": { + "type": "string", + "description": "The client secret of the OAuth 2.0 application." + }, + "clientId": { + "type": "string", + "description": "The client id of the OAuth 2.0 application." + }, + "authorizationCode": { + "type": "string", + "description": "The authorization code used in OAuth 2.0 code flow to issue a token." + }, + "userName": { + "type": "string", + "description": "The user name in the audit log server." + }, + "password": { + "type": "string", + "description": "The user password in the audit log server.", + "x-ms-secret": true + }, + "requestConfigUserInputValues": { + "type": "array", + "description": "", + "x-ms-identifiers": [], + "items": { + "type": "object" + } + } + } + }, + "CodelessApiPollingDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents Codeless API Polling data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/ApiPollingParameters", + "description": "Codeless poling data connector properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "APIPolling" + }, + "ApiPollingParameters": { + "description": "Represents Codeless API Polling data connector", + "type": "object", + "properties": { + "connectorUiConfig": { + "$ref": "#/definitions/CodelessUiConnectorConfigProperties", + "description": "Config to describe the instructions blade" + }, + "pollingConfig": { + "$ref": "#/definitions/CodelessConnectorPollingConfigProperties", + "description": "Config to describe the polling instructions" + } + } + }, + "CodelessConnectorPollingConfigProperties": { + "description": "Config to describe the polling config for API poller connector", + "type": "object", + "properties": { + "isActive": { + "description": "The poller active status", + "type": "boolean" + }, + "auth": { + "type": "object", + "$ref": "#/definitions/CodelessConnectorPollingAuthProperties", + "description": "Describe the authentication type of the poller" + }, + "request": { + "type": "object", + "$ref": "#/definitions/CodelessConnectorPollingRequestProperties", + "description": "Describe the poll request config parameters of the poller" + }, + "paging": { + "type": "object", + "$ref": "#/definitions/CodelessConnectorPollingPagingProperties", + "description": "Describe the poll request paging config of the poller" + }, + "response": { + "type": "object", + "$ref": "#/definitions/CodelessConnectorPollingResponseProperties", + "description": "Describe the response config parameters of the poller" + } + }, + "required": [ + "auth", + "request" + ] + }, + "CodelessConnectorPollingResponseProperties": { + "description": "Describes the response from the external server", + "type": "object", + "properties": { + "eventsJsonPaths": { + "description": "Describes the path we should extract the data in the response", + "x-ms-identifiers": [], + "items": { + "type": "string" + }, + "type": "array" + }, + "successStatusJsonPath": { + "description": "Describes the path we should extract the status code in the response", + "type": "string" + }, + "successStatusValue": { + "description": "Describes the path we should extract the status value in the response", + "type": "string" + }, + "isGzipCompressed": { + "description": "Describes if the data in the response is Gzip", + "type": "boolean" + } + }, + "required": [ + "eventsJsonPaths" + ] + }, + "CodelessConnectorPollingPagingProperties": { + "description": "Describe the properties needed to make a pagination call", + "type": "object", + "properties": { + "pagingType": { + "description": "Describes the type. could be 'None', 'PageToken', 'PageCount', 'TimeStamp'", + "type": "string" + }, + "nextPageParaName": { + "description": "Defines the name of a next page attribute", + "type": "string" + }, + "nextPageTokenJsonPath": { + "description": "Defines the path to a next page token JSON", + "type": "string" + }, + "pageCountAttributePath": { + "description": "Defines the path to a page count attribute", + "type": "string" + }, + "pageTotalCountAttributePath": { + "description": "Defines the path to a page total count attribute", + "type": "string" + }, + "pageTimeStampAttributePath": { + "description": "Defines the path to a paging time stamp attribute", + "type": "string" + }, + "searchTheLatestTimeStampFromEventsList": { + "description": "Determines whether to search for the latest time stamp in the events list", + "type": "string" + }, + "pageSizeParaName": { + "description": "Defines the name of the page size parameter", + "type": "string" + }, + "pageSize": { + "description": "Defines the paging size", + "format": "int32", + "type": "integer" + } + }, + "required": [ + "pagingType" + ] + }, + "CodelessConnectorPollingRequestProperties": { + "description": "Describe the request properties needed to successfully pull from the server", + "type": "object", + "properties": { + "apiEndpoint": { + "description": "Describe the endpoint we should pull the data from", + "type": "string" + }, + "rateLimitQps": { + "description": "Defines the rate limit QPS", + "format": "int32", + "type": "integer" + }, + "queryWindowInMin": { + "description": "The window interval we will use the pull the data", + "format": "int32", + "type": "integer" + }, + "httpMethod": { + "description": "The http method type we will use in the poll request, GET or POST", + "type": "string" + }, + "queryTimeFormat": { + "description": "The time format will be used the query events in a specific window", + "type": "string" + }, + "retryCount": { + "description": "Describe the amount of time we should try and poll the data in case of failure", + "format": "int32", + "type": "integer" + }, + "timeoutInSeconds": { + "description": "The number of seconds we will consider as a request timeout", + "format": "int32", + "type": "integer" + }, + "headers": { + "description": "Describe the headers sent in the poll request", + "type": "object" + }, + "queryParameters": { + "description": "Describe the query parameters sent in the poll request", + "type": "object" + }, + "queryParametersTemplate": { + "description": "For advanced scenarios for example user name/password embedded in nested JSON payload", + "type": "string" + }, + "startTimeAttributeName": { + "description": "This will be used the query events from a start of the time window", + "type": "string" + }, + "endTimeAttributeName": { + "description": "This will be used the query events from the end of the time window", + "type": "string" + } + }, + "required": [ + "apiEndpoint", + "httpMethod", + "queryWindowInMin", + "queryTimeFormat" + ] + }, + "CodelessConnectorPollingAuthProperties": { + "description": "Describe the authentication properties needed to successfully authenticate with the server", + "type": "object", + "properties": { + "authType": { + "description": "The authentication type", + "type": "string" + }, + "apiKeyName": { + "description": "The header name which the token is sent with", + "type": "string" + }, + "apiKeyIdentifier": { + "description": "A prefix send in the header before the actual token", + "type": "string" + }, + "isApiKeyInPostPayload": { + "description": "Marks if the key should sent in header", + "type": "string" + }, + "flowName": { + "description": "Describes the flow name, for example 'AuthCode' for Oauth 2.0", + "type": "string" + }, + "tokenEndpoint": { + "description": "The endpoint used to issue a token, used in Oauth 2.0 flow", + "type": "string" + }, + "authorizationEndpoint": { + "description": "The endpoint used to authorize the user, used in Oauth 2.0 flow", + "type": "string" + }, + "authorizationEndpointQueryParameters": { + "description": "The query parameters used in authorization request, used in Oauth 2.0 flow", + "type": "object" + }, + "redirectionEndpoint": { + "description": "The redirect endpoint where we will get the authorization code, used in Oauth 2.0 flow", + "type": "string" + }, + "tokenEndpointHeaders": { + "description": "The query headers used in token request, used in Oauth 2.0 flow", + "type": "object" + }, + "tokenEndpointQueryParameters": { + "description": "The query parameters used in token request, used in Oauth 2.0 flow", + "type": "object" + }, + "isClientSecretInHeader": { + "description": "Marks if we should send the client secret in header or payload, used in Oauth 2.0 flow", + "type": "boolean" + }, + "scope": { + "description": "The OAuth token scope", + "type": "string" + } + }, + "required": [ + "authType" + ] + }, + "LastDataReceivedDataType": { + "description": "Data type for last data received", + "type": "object", + "properties": { + "name": { + "description": "Name of the data type to show in the graph. can be use with {{graphQueriesTableName}} placeholder", + "type": "string" + }, + "lastDataReceivedQuery": { + "description": "Query for indicate last data received", + "type": "string" + } + } + }, + "Permissions": { + "description": "Permissions required for the connector", + "x-ms-identifiers": [], + "type": "object", + "properties": { + "resourceProvider": { + "description": "Resource provider permissions required for the connector", + "x-ms-identifiers": [], + "items": { + "allOf": [ + { + "$ref": "#/definitions/ResourceProvider" + } + ] + }, + "type": "array" + }, + "customs": { + "description": "Customs permissions required for the connector", + "x-ms-identifiers": [], + "items": { + "allOf": [ + { + "$ref": "#/definitions/Customs" + } + ] + }, + "type": "array" + } + } + }, + "Customs": { + "description": "Customs permissions required for the connector", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CustomsPermission" + } + ] + }, + "CustomsPermission": { + "description": "Customs permissions required for the connector", + "type": "object", + "properties": { + "name": { + "description": "Customs permissions name", + "type": "string" + }, + "description": { + "description": "Customs permissions description", + "type": "string" + } + } + }, + "ResourceProvider": { + "description": "Resource provider permissions required for the connector", + "type": "object", + "properties": { + "provider": { + "description": "Provider name", + "enum": [ + "Microsoft.OperationalInsights/solutions", + "Microsoft.OperationalInsights/workspaces", + "Microsoft.OperationalInsights/workspaces/datasources", + "microsoft.aadiam/diagnosticSettings", + "Microsoft.OperationalInsights/workspaces/sharedKeys", + "Microsoft.Authorization/policyAssignments" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ProviderName" + } + }, + "permissionsDisplayText": { + "description": "Permission description text", + "type": "string" + }, + "providerDisplayName": { + "description": "Permission provider display name", + "type": "string" + }, + "scope": { + "description": "Permission provider scope", + "enum": [ + "ResourceGroup", + "Subscription", + "Workspace" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "PermissionProviderScope" + } + }, + "requiredPermissions": { + "description": "Required permissions for the connector", + "$ref": "#/definitions/RequiredPermissions" + } + } + }, + "InstructionSteps": { + "description": "Instruction steps to enable the connector", + "type": "object", + "properties": { + "title": { + "description": "Instruction step title", + "type": "string" + }, + "description": { + "description": "Instruction step description", + "type": "string" + }, + "instructions": { + "description": "Instruction step details", + "x-ms-identifiers": [], + "items": { + "allOf": [ + { + "$ref": "#/definitions/ConnectorInstructionModelBase" + } + ] + }, + "type": "array" + } + } + }, + "ConnectorInstructionModelBase": { + "description": "Instruction step details", + "type": "object", + "properties": { + "parameters": { + "type": "object", + "description": "The parameters for the setting" + }, + "type": { + "description": "The kind of the setting", + "enum": [ + "CopyableLabel", + "InstructionStepsGroup", + "InfoMessage" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SettingType" + } + } + }, + "required": [ + "type" + ] + }, + "RequiredPermissions": { + "description": "Required permissions for the connector", + "type": "object", + "properties": { + "action": { + "description": "action permission", + "type": "boolean" + }, + "write": { + "description": "write permission", + "type": "boolean" + }, + "read": { + "description": "read permission", + "type": "boolean" + }, + "delete": { + "description": "delete permission", + "type": "boolean" + } + } + }, + "Availability": { + "description": "Connector Availability Status", + "type": "object", + "properties": { + "status": { + "description": "The connector Availability Status", + "format": "int32", + "type": "integer", + "enum": [ + 1 + ], + "x-ms-enum": { + "name": "AvailabilityStatus", + "values": [ + { + "value": 1, + "description": "Available" + } + ] + } + }, + "isPreview": { + "description": "Set connector as preview", + "type": "boolean" + } + } + }, + "ConnectivityCriteria": { + "description": "Setting for the connector check connectivity", + "type": "object", + "properties": { + "type": { + "description": "type of connectivity", + "enum": [ + "IsConnectedQuery" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "ConnectivityType" + } + }, + "value": { + "description": "Queries for checking connectivity", + "x-ms-identifiers": [], + "type": "array", + "items": { + "description": "checking connectivity query", + "type": "string" + } + } + } + }, + "SampleQueries": { + "description": "The sample queries for the connector", + "type": "object", + "properties": { + "description": { + "description": "The sample query description", + "type": "string" + }, + "query": { + "description": "the sample query", + "type": "string" + } + } + }, + "GraphQueries": { + "type": "object", + "description": "The graph query to show the current data status", + "properties": { + "metricName": { + "description": "the metric that the query is checking", + "type": "string" + }, + "legend": { + "description": "The legend for the graph", + "type": "string" + }, + "baseQuery": { + "description": "The base query for the graph", + "type": "string" + } + } + } + }, + "parameters": { + "DataConnector": { + "description": "The data connector", + "in": "body", + "name": "dataConnector", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnector" + }, + "x-ms-parameter-location": "method" + }, + "DataConnectorId": { + "description": "Connector ID", + "in": "path", + "name": "dataConnectorId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DataConnectorConnectBody": { + "description": "The data connector", + "in": "body", + "name": "connectBody", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectorConnectBody" + }, + "x-ms-parameter-location": "method" + }, + "DataConnectorsCheckRequirementsBody": { + "description": "The parameters for requirements check message", + "in": "body", + "name": "DataConnectorsCheckRequirements", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectorsCheckRequirements" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/CreateActionOfAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/CreateActionOfAlertRule.json new file mode 100644 index 000000000000..6b371016faee --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/CreateActionOfAlertRule.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "action": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "triggerUri": "https://prod-31.northcentralus.logic.azure.com:443/workflows/cd3765391efd48549fd7681ded1d48d7/triggers/manual/paths/invoke?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=signature", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5/actions/912bec42-cb66-4c03-ac63-1761b6898c3e", + "name": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "type": "Microsoft.SecurityInsights/alertRules/actions", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5/actions/912bec42-cb66-4c03-ac63-1761b6898c3e", + "name": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "type": "Microsoft.SecurityInsights/alertRules/actions", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/DeleteActionOfAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/DeleteActionOfAlertRule.json new file mode 100644 index 000000000000..6537a0327d08 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/DeleteActionOfAlertRule.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/GetActionOfAlertRuleById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/GetActionOfAlertRuleById.json new file mode 100644 index 000000000000..866251758923 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/GetActionOfAlertRuleById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5/actions/912bec42-cb66-4c03-ac63-1761b6898c3e", + "name": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "type": "Microsoft.SecurityInsights/alertRules/actions", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/GetAllActionsByAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/GetAllActionsByAlertRule.json new file mode 100644 index 000000000000..44c696fb4f42 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/actions/GetAllActionsByAlertRule.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5/actions/912bec42-cb66-4c03-ac63-1761b6898c3e", + "name": "912bec42-cb66-4c03-ac63-1761b6898c3e", + "type": "Microsoft.SecurityInsights/alertRules/actions", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "workflowId": "cd3765391efd48549fd7681ded1d48d7", + "logicAppResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/MyAlerts" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json new file mode 100644 index 000000000000..6b8d1bd45265 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplateById.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "alertRuleTemplateId": "65360bb0-8986-4ade-a89d-af3cf44d28aa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRuleTemplates/65360bb0-8986-4ade-a89d-af3cf44d28aa", + "name": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "Scheduled", + "properties": { + "severity": "Low", + "query": "let timeframe = 1d;\nAWSCloudTrail\n| where TimeGenerated >= ago(timeframe)\n| where EventName == \"CreateNetworkAclEntry\"\n or EventName == \"CreateRoute\"\n| project TimeGenerated, EventName, EventTypeName, UserIdentityAccountId, UserIdentityPrincipalid, UserAgent, UserIdentityUserName, SessionMfaAuthenticated, SourceIpAddress, AWSRegion, EventSource, AdditionalEventData, ResponseElements\n| extend AccountCustomEntity = UserIdentityUserName, IPCustomEntity = SourceIpAddress", + "queryFrequency": "P1D", + "queryPeriod": "P1D", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "displayName": "Changes to Amazon VPC settings", + "description": "This alert monitors changes to Amazon VPC (Virtual Private Cloud) settings such as new ACL entries and routes in route tables.\nMore information: https://medium.com/@GorillaStack/the-most-important-aws-cloudtrail-security-events-to-track-a5b9873f8255 \nand https://aws.amazon.com/vpc/", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "tactics": [ + "PrivilegeEscalation", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "lastUpdatedDateUTC": "2020-02-27T00:00:00Z", + "version": "1.0.2", + "createdDateUTC": "2019-02-27T00:00:00Z", + "status": "Available", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "alertRulesCreatedByTemplateCount": 0 + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json new file mode 100644 index 000000000000..7300f7b7c490 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRuleTemplates/GetAlertRuleTemplates.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/AlertRuleTemplates/65360bb0-8986-4ade-a89d-af3cf44d28aa", + "name": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "Scheduled", + "properties": { + "severity": "Low", + "query": "let timeframe = 1d;\nAWSCloudTrail\n| where TimeGenerated >= ago(timeframe)\n| where EventName == \"CreateNetworkAclEntry\"\n or EventName == \"CreateRoute\"\n| project TimeGenerated, EventName, EventTypeName, UserIdentityAccountId, UserIdentityPrincipalid, UserAgent, UserIdentityUserName, SessionMfaAuthenticated, SourceIpAddress, AWSRegion, EventSource, AdditionalEventData, ResponseElements\n| extend AccountCustomEntity = UserIdentityUserName, IPCustomEntity = SourceIpAddress", + "queryFrequency": "P1D", + "queryPeriod": "P1D", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "displayName": "Changes to Amazon VPC settings", + "description": "This alert monitors changes to Amazon VPC (Virtual Private Cloud) settings such as new ACL entries and routes in route tables.\nMore information: https://medium.com/@GorillaStack/the-most-important-aws-cloudtrail-security-events-to-track-a5b9873f8255 \nand https://aws.amazon.com/vpc/", + "tactics": [ + "PrivilegeEscalation", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "lastUpdatedDateUTC": "2020-02-27T00:00:00Z", + "createdDateUTC": "2019-02-27T00:00:00Z", + "status": "Available", + "version": "1.0.1", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "alertRulesCreatedByTemplateCount": 0 + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/AlertRuleTemplates/f71aba3d-28fb-450b-b192-4e76a83015c8", + "name": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Microsoft Sentinel uses Fusion, a correlation engine based on scalable machine learning algorithms, to automatically detect multistage attacks by identifying combinations of anomalous behaviors and suspicious activities that are observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nSince Fusion correlates multiple signals from various products to detect advanced multistage attacks, successful Fusion detections are presented as Fusion incidents on the Microsoft Sentinel Incidents page. This rule covers the following detections:\n- Fusion for emerging threats\n- Fusion for ransomware\n- Scenario-based Fusion detections (122 scenarios)\n\nTo enable these detections, we recommend you configure the following data connectors for best results:\n- Out-of-the-box anomaly detections\n- Azure Active Directory Identity Protection\n- Azure Defender\n- Azure Defender for IoT\n- Microsoft 365 Defender\n- Microsoft Cloud App Security \n- Microsoft Defender for Endpoint\n- Microsoft Defender for Identity\n- Microsoft Defender for Office 365\n- Palo Alto Networks\n- Scheduled analytics rules, both built-in and those created by your security analysts. Analytics rules must contain kill-chain (tactics) and entity mapping information in order to be used by Fusion.\n\nFor the full description of each detection that is supported by Fusion, go to https://aka.ms/SentinelFusion.", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "severityFilter": { + "enabled": true, + "isSupported": true, + "severityFilters": [ + "Informational", + "Low", + "Medium", + "High" + ] + } + } + ] + }, + { + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "severityFilter": { + "enabled": false, + "isSupported": false, + "severityFilters": null + } + } + ] + } + ], + "lastUpdatedDateUTC": "2021-06-09T00:00:00Z", + "createdDateUTC": "2019-07-25T00:00:00Z", + "status": "Available", + "severity": "High", + "alertRulesCreatedByTemplateCount": 0 + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/AlertRuleTemplates/b3cfc7c0-092c-481c-a55b-34a3979758cb", + "name": "b3cfc7c0-092c-481c-a55b-34a3979758cb", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "displayName": "Create incidents based on Microsoft Cloud App Security alerts", + "description": "Create incidents based on all alerts generated in Microsoft Cloud App Security", + "lastUpdatedDateUTC": "2020-02-27T00:00:00Z", + "createdDateUTC": "2019-07-16T00:00:00Z", + "status": "Available", + "alertRulesCreatedByTemplateCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateFusionAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateFusionAlertRule.json new file mode 100644 index 000000000000..0f61c53a51bc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateFusionAlertRule.json @@ -0,0 +1,845 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "myFirstFusionRule", + "alertRule": { + "kind": "Fusion", + "etag": "3d00c3ca-0000-0100-0000-5d42d5010000", + "properties": { + "enabled": true, + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "filters": null + } + } + ] + } + ], + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Using Fusion technology based on machine learning, Azure Sentinel automatically detects multistage attacks by identifying combinations of anomalous behaviors and suspicious activities observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nThere are a total of 122 Fusion incident types detected by Azure Sentinel.\n\nTo detect these multistage attacks, the following data connectors must be configured:\n- Azure Active Directory Identity Protection.\n- Microsoft Cloud App Security.\n- Microsoft Defender for Endpoint.\n- Azure Defender.\n- Palo Alto Networks.\n- Scheduled Analytics Rules supported by Fusion\n\nFor a full list and description of each scenario that is supported for these multistage attacks, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Using Fusion technology based on machine learning, Azure Sentinel automatically detects multistage attacks by identifying combinations of anomalous behaviors and suspicious activities observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nThere are a total of 122 Fusion incident types detected by Azure Sentinel.\n\nTo detect these multistage attacks, the following data connectors must be configured:\n- Azure Active Directory Identity Protection.\n- Microsoft Cloud App Security.\n- Microsoft Defender for Endpoint.\n- Azure Defender.\n- Palo Alto Networks.\n- Scheduled Analytics Rules supported by Fusion\n\nFor a full list and description of each scenario that is supported for these multistage attacks, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json new file mode 100644 index 000000000000..62495324948f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateFusionAlertRuleWithFusionScenarioExclusion.json @@ -0,0 +1,851 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "myFirstFusionRule", + "alertRule": { + "kind": "Fusion", + "etag": "3d00c3ca-0000-0100-0000-5d42d5010000", + "properties": { + "enabled": true, + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "filters": null + } + } + ] + } + ], + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Using Fusion technology based on machine learning, Azure Sentinel automatically detects multistage attacks by identifying combinations of anomalous behaviors and suspicious activities observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nThere are a total of 122 Fusion incident types detected by Azure Sentinel.\n\nTo detect these multistage attacks, the following data connectors must be configured:\n- Azure Active Directory Identity Protection.\n- Microsoft Cloud App Security.\n- Microsoft Defender for Endpoint.\n- Azure Defender.\n- Palo Alto Networks.\n- Scheduled Analytics Rules supported by Fusion\n\nFor a full list and description of each scenario that is supported for these multistage attacks, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Using Fusion technology based on machine learning, Azure Sentinel automatically detects multistage attacks by identifying combinations of anomalous behaviors and suspicious activities observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nThere are a total of 122 Fusion incident types detected by Azure Sentinel.\n\nTo detect these multistage attacks, the following data connectors must be configured:\n- Azure Active Directory Identity Protection.\n- Microsoft Cloud App Security.\n- Microsoft Defender for Endpoint.\n- Azure Defender.\n- Palo Alto Networks.\n- Scheduled Analytics Rules supported by Fusion\n\nFor a full list and description of each scenario that is supported for these multistage attacks, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "scenarioExclusionPatterns": [ + { + "exclusionPattern": "Alert providers:Azure Active Directory Identity Protection:Infected Device;Alert providers:Azure Defender:Crypto-mining activity", + "dateAddedInUTC": "2021-10-01T15:26:44.9429806Z" + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2019-09-04T13:13:11.5340061Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json new file mode 100644 index 000000000000..d27721a31321 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateMicrosoftSecurityIncidentCreationAlertRule.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "microsoftSecurityIncidentCreationRuleExample", + "alertRule": { + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "displayName": "testing displayname", + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateNrtAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateNrtAlertRule.json new file mode 100644 index 000000000000..ad62aa65fab7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateNrtAlertRule.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "alertRule": { + "kind": "NRT", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host", + "Account" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "NRT", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "lastModifiedUtc": "2019-01-01T13:15:30Z", + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host", + "Account" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "NRT", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "lastModifiedUtc": "2019-01-01T13:15:30Z", + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host", + "Account" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateScheduledAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateScheduledAlertRule.json new file mode 100644 index 000000000000..7ccbd71241c2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/CreateScheduledAlertRule.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "alertRule": { + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "sentinelEntitiesMappings": [ + { + "columnName": "Entities" + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertDynamicProperties": [ + { + "alertProperty": "ProductComponentName", + "value": "ProductComponentNameCustomColumn" + }, + { + "alertProperty": "ProductName", + "value": "ProductNameCustomColumn" + }, + { + "alertProperty": "AlertLink", + "value": "Link" + } + ] + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"01005144-0000-0d00-0000-6058632c0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:17:30Z", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"01007444-0000-0d00-0000-605863a70000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:15:30Z", + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/DeleteAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/DeleteAlertRule.json new file mode 100644 index 000000000000..fd68352a63fc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/DeleteAlertRule.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetAllAlertRules.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetAllAlertRules.json new file mode 100644 index 000000000000..3297c5f505b5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetAllAlertRules.json @@ -0,0 +1,412 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:17:30Z", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"25005c11-0000-0d00-0000-5d6cc0e20000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Microsoft Sentinel uses Fusion, a correlation engine based on scalable machine learning algorithms, to automatically detect multistage attacks by identifying combinations of anomalous behaviors and suspicious activities that are observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nSince Fusion correlates multiple signals from various products to detect advanced multistage attacks, successful Fusion detections are presented as Fusion incidents on the Microsoft Sentinel Incidents page. This rule covers the following detections:\n- Fusion for emerging threats\n- Fusion for ransomware\n- Scenario-based Fusion detections (122 scenarios)\n\nTo enable these detections, we recommend you configure the following data connectors for best results:\n- Out-of-the-box anomaly detections\n- Azure Active Directory Identity Protection\n- Azure Defender\n- Azure Defender for IoT\n- Microsoft 365 Defender\n- Microsoft Cloud App Security \n- Microsoft Defender for Endpoint\n- Microsoft Defender for Identity\n- Microsoft Defender for Office 365\n- Palo Alto Networks\n- Scheduled analytics rules, both built-in and those created by your security analysts. Analytics rules must contain kill-chain (tactics) and entity mapping information in order to be used by Fusion.\n\nFor the full description of each detection that is supported by Fusion, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "sourceSubTypeDisplayName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "sourceSubTypeDisplayName": "Microsoft Defender for Cloud", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "sourceSubTypeDisplayName": "Microsoft Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "sourceSubTypeDisplayName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "sourceSubTypeDisplayName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "sourceSubTypeDisplayName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "sourceSubTypeDisplayName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "sourceSubTypeDisplayName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "sourceSubTypeDisplayName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "sourceSubTypeDisplayName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2021-10-22T07:12:34.9065092Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetFusionAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetFusionAlertRule.json new file mode 100644 index 000000000000..9ca32bd5dd06 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetFusionAlertRule.json @@ -0,0 +1,310 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "myFirstFusionRule" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/myFirstFusionRule", + "name": "myFirstFusionRule", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Microsoft Sentinel uses Fusion, a correlation engine based on scalable machine learning algorithms, to automatically detect multistage attacks by identifying combinations of anomalous behaviors and suspicious activities that are observed at various stages of the kill chain. On the basis of these discoveries, Azure Sentinel generates incidents that would otherwise be very difficult to catch. By design, these incidents are low-volume, high-fidelity, and high-severity, which is why this detection is turned ON by default.\n\nSince Fusion correlates multiple signals from various products to detect advanced multistage attacks, successful Fusion detections are presented as Fusion incidents on the Microsoft Sentinel Incidents page. This rule covers the following detections:\n- Fusion for emerging threats\n- Fusion for ransomware\n- Scenario-based Fusion detections (122 scenarios)\n\nTo enable these detections, we recommend you configure the following data connectors for best results:\n- Out-of-the-box anomaly detections\n- Azure Active Directory Identity Protection\n- Azure Defender\n- Azure Defender for IoT\n- Microsoft 365 Defender\n- Microsoft Cloud App Security \n- Microsoft Defender for Endpoint\n- Microsoft Defender for Identity\n- Microsoft Defender for Office 365\n- Palo Alto Networks\n- Scheduled analytics rules, both built-in and those created by your security analysts. Analytics rules must contain kill-chain (tactics) and entity mapping information in order to be used by Fusion.\n\nFor the full description of each detection that is supported by Fusion, go to https://aka.ms/SentinelFusion.", + "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "tactics": [ + "Collection", + "CommandAndControl", + "CredentialAccess", + "DefenseEvasion", + "Discovery", + "Execution", + "Exfiltration", + "Impact", + "InitialAccess", + "LateralMovement", + "Persistence", + "PrivilegeEscalation" + ], + "sourceSettings": [ + { + "enabled": true, + "sourceName": "Anomalies", + "sourceSubTypes": null + }, + { + "enabled": true, + "sourceName": "Alert providers", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Azure Active Directory Identity Protection", + "sourceSubTypeDisplayName": "Azure Active Directory Identity Protection", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender", + "sourceSubTypeDisplayName": "Microsoft Defender for Cloud", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Defender for IoT", + "sourceSubTypeDisplayName": "Microsoft Defender for IoT", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft 365 Defender", + "sourceSubTypeDisplayName": "Microsoft 365 Defender", + "enabled": true, + "severityFilter": [ + "High", + "Medium", + "Low", + "Informational" + ], + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Cloud App Security", + "sourceSubTypeDisplayName": "Microsoft Cloud App Security", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Endpoint", + "sourceSubTypeDisplayName": "Microsoft Defender for Endpoint", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Identity", + "sourceSubTypeDisplayName": "Microsoft Defender for Identity", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Microsoft Defender for Office 365", + "sourceSubTypeDisplayName": "Microsoft Defender for Office 365", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + }, + { + "sourceSubTypeName": "Azure Sentinel scheduled analytics rules", + "sourceSubTypeDisplayName": "Azure Sentinel scheduled analytics rules", + "enabled": true, + "severityFilters": { + "isSupported": true, + "filters": [ + { + "severity": "High", + "enabled": true + }, + { + "severity": "Medium", + "enabled": true + }, + { + "severity": "Low", + "enabled": true + }, + { + "severity": "Informational", + "enabled": true + } + ] + } + } + ] + }, + { + "enabled": true, + "sourceName": "Raw logs from other sources", + "sourceSubTypes": [ + { + "sourceSubTypeName": "Palo Alto Networks", + "sourceSubTypeDisplayName": "Palo Alto Networks", + "enabled": true, + "severityFilters": { + "isSupported": false, + "filters": null + } + } + ] + } + ], + "severity": "High", + "enabled": true, + "lastModifiedUtc": "2021-10-20T13:13:11.5340061Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json new file mode 100644 index 000000000000..f57875b43555 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetMicrosoftSecurityIncidentCreationAlertRule.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "microsoftSecurityIncidentCreationRuleExample" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExample", + "name": "microsoftSecurityIncidentCreationRuleExample", + "etag": "\"260097e0-0000-0d00-0000-5d6fa88f0000\"", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "severitiesFilter": null, + "displayNamesFilter": null, + "displayName": "testing displayname", + "enabled": true, + "description": null, + "alertRuleTemplateName": null, + "lastModifiedUtc": "2019-09-04T12:05:35.7296311Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetNrtAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetNrtAlertRule.json new file mode 100644 index 000000000000..8a0846bf4a84 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetNrtAlertRule.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "NRT", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "Rule2", + "description": "", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "ProtectionStatus | extend HostCustomEntity = Computer | extend IPCustomEntity = ComputerIP_Hidden", + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "lastModifiedUtc": "2019-01-01T13:15:30Z", + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host", + "Account" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetScheduledAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetScheduledAlertRule.json new file mode 100644 index 000000000000..832fac69b6eb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/alertRules/GetScheduledAlertRule.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/alertRules", + "kind": "Scheduled", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "alertRuleTemplateName": null, + "displayName": "My scheduled rule", + "description": "An example for a scheduled rule", + "severity": "High", + "enabled": true, + "tactics": [ + "Persistence", + "LateralMovement" + ], + "techniques": [ + "T1037", + "T1021" + ], + "query": "Heartbeat", + "queryFrequency": "PT1H", + "queryPeriod": "P2DT1H30M", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "lastModifiedUtc": "2021-03-01T13:17:30Z", + "eventGroupingSettings": { + "aggregationKind": "AlertPerResult" + }, + "customDetails": { + "OperatingSystemName": "OSName", + "OperatingSystemType": "OSType" + }, + "entityMappings": [ + { + "entityType": "Host", + "fieldMappings": [ + { + "identifier": "FullName", + "columnName": "Computer" + } + ] + }, + { + "entityType": "IP", + "fieldMappings": [ + { + "identifier": "Address", + "columnName": "ComputerIP" + } + ] + } + ], + "alertDetailsOverride": { + "alertDisplayNameFormat": "Alert from {{Computer}}", + "alertDescriptionFormat": "Suspicious activity was made by {{ComputerIP}}", + "alertTacticsColumnName": null, + "alertSeverityColumnName": null + }, + "incidentConfiguration": { + "createIncident": true, + "groupingConfiguration": { + "enabled": true, + "reopenClosedIncident": false, + "lookbackDuration": "PT5H", + "matchingMethod": "Selected", + "groupByEntities": [ + "Host" + ], + "groupByAlertDetails": [ + "DisplayName" + ], + "groupByCustomDetails": [ + "OperatingSystemType", + "OperatingSystemName" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json new file mode 100644 index 000000000000..6732767a69d6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_CreateOrUpdate.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "automationRuleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "automationRule": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/automationRules", + "properties": { + "displayName": "Suspicious user sign-in events", + "order": 1, + "triggeringLogic": { + "isEnabled": true, + "triggersOn": "Incidents", + "triggersWhen": "Created", + "conditions": [ + { + "conditionType": "Property", + "conditionProperties": { + "propertyName": "IncidentRelatedAnalyticRuleIds", + "operator": "Contains", + "propertyValues": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7", + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/8deb8303-e94d-46ff-96e0-5fd94b33df1a" + ] + } + } + ] + }, + "actions": [ + { + "order": 1, + "actionType": "AddIncidentTask", + "actionConfiguration": { + "title": "Reset user passwords", + "description": "Reset passwords for compromised users." + } + } + ], + "lastModifiedTimeUtc": "2019-01-01T13:00:30Z", + "createdTimeUtc": "2019-01-01T13:00:00Z", + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/automationRules", + "properties": { + "displayName": "Suspicious user sign-in events", + "order": 1, + "triggeringLogic": { + "isEnabled": true, + "triggersOn": "Incidents", + "triggersWhen": "Created", + "conditions": [ + { + "conditionType": "Property", + "conditionProperties": { + "propertyName": "IncidentRelatedAnalyticRuleIds", + "operator": "Contains", + "propertyValues": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7", + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/8deb8303-e94d-46ff-96e0-5fd94b33df1a" + ] + } + } + ] + }, + "actions": [ + { + "order": 1, + "actionType": "AddIncidentTask", + "actionConfiguration": { + "title": "Reset user passwords", + "description": "Reset passwords for compromised users." + } + } + ], + "lastModifiedTimeUtc": "2019-01-01T13:00:30Z", + "createdTimeUtc": "2019-01-01T13:00:00Z", + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/automationRules", + "properties": { + "displayName": "Suspicious user sign-in events", + "order": 1, + "triggeringLogic": { + "isEnabled": true, + "triggersOn": "Incidents", + "triggersWhen": "Created", + "conditions": [ + { + "conditionType": "Property", + "conditionProperties": { + "propertyName": "IncidentRelatedAnalyticRuleIds", + "operator": "Contains", + "propertyValues": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7", + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/8deb8303-e94d-46ff-96e0-5fd94b33df1a" + ] + } + } + ] + }, + "actions": [ + { + "order": 1, + "actionType": "AddIncidentTask", + "actionConfiguration": { + "title": "Reset user passwords", + "description": "Reset passwords for compromised users." + } + } + ], + "lastModifiedTimeUtc": "2019-01-01T13:00:30Z", + "createdTimeUtc": "2019-01-01T13:00:00Z", + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_Delete.json new file mode 100644 index 000000000000..5478aa66e1d7 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "automationRuleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": {} + }, + "204": { + "body": {} + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_Get.json new file mode 100644 index 000000000000..0aad494fdf88 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_Get.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "automationRuleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/automationRules", + "properties": { + "displayName": "Suspicious user sign-in events", + "order": 1, + "triggeringLogic": { + "isEnabled": true, + "triggersOn": "Incidents", + "triggersWhen": "Created", + "conditions": [ + { + "conditionType": "Property", + "conditionProperties": { + "propertyName": "IncidentRelatedAnalyticRuleIds", + "operator": "Contains", + "propertyValues": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7", + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/8deb8303-e94d-46ff-96e0-5fd94b33df1a" + ] + } + } + ] + }, + "actions": [ + { + "order": 1, + "actionType": "AddIncidentTask", + "actionConfiguration": { + "title": "Reset user passwords", + "description": "Reset passwords for compromised users." + } + } + ], + "lastModifiedTimeUtc": "2019-01-01T13:00:30Z", + "createdTimeUtc": "2019-01-01T13:00:00Z", + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_List.json new file mode 100644 index 000000000000..f7f0d7aae2e0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/automationRules/AutomationRules_List.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/automationRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/automationRules", + "properties": { + "displayName": "Suspicious user sign-in events", + "order": 1, + "triggeringLogic": { + "isEnabled": true, + "triggersOn": "Incidents", + "triggersWhen": "Created", + "conditions": [ + { + "conditionType": "Property", + "conditionProperties": { + "propertyName": "IncidentRelatedAnalyticRuleIds", + "operator": "Contains", + "propertyValues": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7", + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/8deb8303-e94d-46ff-96e0-5fd94b33df1a" + ] + } + } + ] + }, + "actions": [ + { + "order": 1, + "actionType": "AddIncidentTask", + "actionConfiguration": { + "title": "Reset user passwords", + "description": "Reset passwords for compromised users." + } + } + ], + "lastModifiedTimeUtc": "2019-01-01T13:00:30Z", + "createdTimeUtc": "2019-01-01T13:00:00Z", + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/billingStatistics/GetAllBillingStatistics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/billingStatistics/GetAllBillingStatistics.json new file mode 100644 index 000000000000..1be0f59dbb69 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/billingStatistics/GetAllBillingStatistics.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/billingStatistics/sapUsage", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "sapSolutionUsage", + "type": "Microsoft.SecurityInsights/billingStatistics", + "kind": "SapSolutionUsage", + "properties": { + "activeSystemIdCount": 5 + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/billingStatistics/GetBillingStatistic.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/billingStatistics/GetBillingStatistic.json new file mode 100644 index 000000000000..6d05d9fa9ef8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/billingStatistics/GetBillingStatistic.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "billingStatisticName": "sapSolutionUsage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/billingStatistics/sapUsage", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "sapSolutionUsage", + "type": "Microsoft.SecurityInsights/billingStatistics", + "kind": "SapSolutionUsage", + "properties": { + "activeSystemIdCount": 5 + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/CreateBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/CreateBookmark.json new file mode 100644 index 000000000000..fe51ef9c1467 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/CreateBookmark.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "bookmark": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My bookmark", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70" + }, + "updated": "2021-09-01T13:15:30Z", + "created": "2021-09-01T13:15:30Z", + "notes": "Found a suspicious activity", + "labels": [ + "Tag1", + "Tag2" + ], + "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)", + "queryResult": "Security Event query result", + "tactics": [ + "Execution" + ], + "techniques": [ + "T1609" + ], + "entityMappings": [ + { + "entityType": "Account", + "fieldMappings": [ + { + "identifier": "Fullname", + "value": "johndoe@microsoft.com" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/bookmarks", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My bookmark", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updated": "2021-09-01T13:15:30Z", + "created": "2021-09-01T13:15:30Z", + "notes": "Found a suspicious activity", + "labels": [ + "Tag1", + "Tag2" + ], + "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)", + "queryResult": "Security Event query result", + "tactics": [ + "Execution" + ], + "techniques": [ + "T1609" + ], + "entityMappings": [ + { + "entityType": "Account", + "fieldMappings": [ + { + "identifier": "Fullname", + "value": "johndoe@microsoft.com" + } + ] + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/bookmarks", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My bookmark", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updated": "2021-09-01T13:15:30Z", + "created": "2021-09-01T13:15:30Z", + "notes": "Found a suspicious activity", + "labels": [ + "Tag1", + "Tag2" + ], + "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)", + "queryResult": "Security Event query result", + "tactics": [ + "Execution" + ], + "techniques": [ + "T1609" + ], + "entityMappings": [ + { + "entityType": "Account", + "fieldMappings": [ + { + "identifier": "Fullname", + "value": "johndoe@microsoft.com" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/DeleteBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/DeleteBookmark.json new file mode 100644 index 000000000000..39464c2a5de9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/DeleteBookmark.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/GetBookmarkById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/GetBookmarkById.json new file mode 100644 index 000000000000..36ffb7dd635d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/GetBookmarkById.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/bookmarks", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My bookmark", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updated": "2021-09-01T13:15:30Z", + "created": "2021-09-01T13:15:30Z", + "notes": "Found a suspicious activity", + "labels": [ + "Tag1", + "Tag2" + ], + "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)", + "queryResult": "Security Event query result", + "incidentInfo": { + "incidentId": "DDA55F97-170B-40B9-B8ED-CBFD05481E7D", + "severity": "Low", + "title": "New case 1", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0018" + }, + "tactics": [ + "Execution" + ], + "techniques": [ + "T1609" + ], + "entityMappings": [ + { + "entityType": "Account", + "fieldMappings": [ + { + "identifier": "Fullname", + "value": "johndoe@microsoft.com" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/GetBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/GetBookmarks.json new file mode 100644 index 000000000000..dd101a10175a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/GetBookmarks.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/bookmarks", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My bookmark", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updated": "2021-09-01T13:15:30Z", + "created": "2021-09-01T13:15:30Z", + "notes": "Found a suspicious activity", + "labels": [ + "Tag1", + "Tag2" + ], + "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)", + "queryResult": "Security Event query result", + "incidentInfo": { + "incidentId": "DDA55F97-170B-40B9-B8ED-CBFD05481E7D", + "severity": "Low", + "title": "New case 1", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0018" + }, + "tactics": [ + "Execution" + ], + "techniques": [ + "T1609" + ], + "entityMappings": [ + { + "entityType": "Account", + "fieldMappings": [ + { + "identifier": "Fullname", + "value": "johndoe@microsoft.com" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/expand/PostExpandBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/expand/PostExpandBookmark.json new file mode 100644 index 000000000000..4726afe9b5d2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/expand/PostExpandBookmark.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "parameters": { + "expansionId": "27f76e63-c41b-480f-bb18-12ad2e011d49", + "startTime": "2019-12-25T17:21:00.000Z", + "endTime": "2020-01-24T17:21:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "value": { + "entities": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/fe4ddab5-8cea-eca3-c8b8-9e92e830a387", + "name": "fe4ddab5-8cea-eca3-c8b8-9e92e830a387", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Account", + "properties": { + "friendlyName": "administrator", + "accountName": "administrator", + "ntDomain": "domain" + } + } + ] + }, + "metaData": { + "aggregations": [ + { + "entityKind": "Account", + "count": 1 + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json new file mode 100644 index 000000000000..c724a87ac4fe --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/CreateBookmarkRelation.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "relation": { + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/bookmarks/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/bookmarks/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json new file mode 100644 index 000000000000..c9d5a5624bf0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/DeleteBookmarkRelation.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json new file mode 100644 index 000000000000..7c634e640477 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/GetAllBookmarkRelations.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/bookmarks/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json new file mode 100644 index 000000000000..50a86902056e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/bookmarks/relations/GetBookmarkRelationByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "bookmarkId": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/bookmarks/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetPackageById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetPackageById.json new file mode 100644 index 000000000000..88a932d9a7ee --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetPackageById.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "packageId": "str.azure-sentinel-solution-str" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/str.azure-sentinel-solution-str", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentKind": "Solution", + "version": "2.0.0", + "displayName": "str" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetPackages.json new file mode 100644 index 000000000000..5aca5a7b4af3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetPackages.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "packageId": "str.azure-sentinel-solution-str" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentKind": "Solution", + "contentSchemaVersion": "3.0.0", + "version": "2.0.0", + "displayName": "str" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetProductPackageById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetProductPackageById.json new file mode 100644 index 000000000000..add77237cae5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetProductPackageById.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "packageId": "str.azure-sentinel-solution-str" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/str.azure-sentinel-solution-str", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentKind": "Solution", + "installedVersion": "2.0.0", + "version": "2.0.0", + "displayName": "str", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01", + "packageContent": "JSON string of the package" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetProductPackages.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetProductPackages.json new file mode 100644 index 000000000000..6b077bb61f4a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/GetProductPackages.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentKind": "Solution", + "installedVersion": "2.0.0", + "version": "2.0.0", + "displayName": "str", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/InstallPackage.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/InstallPackage.json new file mode 100644 index 000000000000..7f8143278573 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/InstallPackage.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "packageId": "str.azure-sentinel-solution-str", + "packageInstallationProperties": { + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentKind": "Solution", + "version": "2.0.0", + "displayName": "str" + }, + "tags": { + "tag1": "str" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/str.azure-sentinel-solution-str", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentKind": "Solution", + "installedVersion": "2.0.0", + "version": "2.0.0", + "displayName": "str", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/str.azure-sentinel-solution-str", + "name": "str.azure-sentinel-solution-str", + "type": "Microsoft.SecurityInsights/contentpackages", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "str.azure-sentinel-solution-str", + "contentKind": "Solution", + "installedVersion": "2.0.0", + "version": "2.0.0", + "displayName": "str", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/UninstallPackage.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/UninstallPackage.json new file mode 100644 index 000000000000..07b9d49cf52a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentPackages/UninstallPackage.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "packageId": "str.azure-sentinel-solution-str" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/DeleteTemplate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/DeleteTemplate.json new file mode 100644 index 000000000000..9947521f034c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/DeleteTemplate.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "templateId": "8365ebfe-a381-45b7-ad08-7d818070e11f" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetProductTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetProductTemplateById.json new file mode 100644 index 000000000000..c9d60a60afbe --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetProductTemplateById.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "templateId": "8365ebfe-a381-45b7-ad08-7d818070e11f" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentTemplates/8365ebfe-a381-45b7-ad08-7d818070e11f", + "name": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "type": "Microsoft.SecurityInsights/contenttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "content id", + "version": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "packageId": "package id", + "packageKind": "Standalone", + "packageName": "package name", + "source": { + "kind": "Standalone", + "name": "Source name" + }, + "mainTemplate": "JSON string of the installed template" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetProductTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetProductTemplates.json new file mode 100644 index 000000000000..2728871fe1e8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetProductTemplates.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentTemplates", + "name": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "type": "Microsoft.SecurityInsights/contenttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "content id", + "version": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "packageId": "package id", + "packageKind": "Standalone", + "packageName": "package name", + "source": { + "kind": "Standalone", + "name": "Source name" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetTemplateById.json new file mode 100644 index 000000000000..1b7dc7964adc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetTemplateById.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "templateId": "8365ebfe-a381-45b7-ad08-7d818070e11f" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentTemplates/8365ebfe-a381-45b7-ad08-7d818070e11f", + "name": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "type": "Microsoft.SecurityInsights/contenttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "content id", + "version": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "packageId": "package id", + "source": { + "kind": "Standalone", + "name": "Source name" + }, + "mainTemplate": "JSON string of the installed template" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetTemplates.json new file mode 100644 index 000000000000..cd8fd3a854cd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/GetTemplates.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentTemplates", + "name": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "type": "Microsoft.SecurityInsights/contenttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "content id", + "version": "1.0.0", + "displayName": "My installed template", + "contentKind": "Workbooks", + "packageId": "package id", + "source": { + "kind": "Standalone", + "name": "Source name" + } + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/InstallTemplate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/InstallTemplate.json new file mode 100644 index 000000000000..68cf6d2407c3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/contentTemplates/InstallTemplate.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfeab2-9ae0-4464-9919-dccaee2e48f0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "templateId": "str.azure-sentinel-solution-str", + "templateInstallationProperties": { + "properties": { + "contentId": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "displayName": "API Protection workbook template", + "contentKind": "AnalyticsRule", + "version": "1.0.1", + "packageId": "str.azure-sentinel-solution-str", + "packageName": "str", + "packageKind": "Solution", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "mainTemplate": { + "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#", + "contentVersion": "1.0.1", + "resources": [ + { + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "name": "8365ebfe-a381-45b7-ad08-7d818070e11f", + "apiVersion": "2022-04-01-preview", + "kind": "Scheduled", + "location": "[parameters('workspace-location')]", + "properties": { + "description": "Creates an incident when a large number of Critical/High severity CrowdStrike Falcon sensor detections is triggered by a single user", + "displayName": "Critical or High Severity Detections by User", + "enabled": false, + "query": "...", + "queryFrequency": "PT1H", + "queryPeriod": "PT1H", + "severity": "High", + "suppressionDuration": "PT1H", + "suppressionEnabled": false, + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "status": "Available" + } + }, + { + "type": "Microsoft.OperationalInsights/workspaces/providers/metadata", + "apiVersion": "2022-01-01-preview", + "name": "[concat(parameters('workspace'),'/Microsoft.SecurityInsights/',concat('AnalyticsRule-', last(split([resourceId('Microsoft.SecurityInsights/AlertRuleTemplates', 8365ebfe-a381-45b7-ad08-7d818070e11f)],'/'))))]", + "properties": { + "description": "CrowdStrike Falcon Endpoint Protection Analytics Rule 1", + "parentId": "[resourceId('Microsoft.SecurityInsights/AlertRuleTemplates', 8365ebfe-a381-45b7-ad08-7d818070e11f)]", + "contentId": "4465ebde-b381-45f7-ad08-7d818070a11c", + "kind": "AnalyticsRule", + "version": "1.0.0", + "source": { + "kind": "Solution", + "name": "str", + "sourceId": "str.azure-sentinel-solution-str" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + } + } + } + ] + } + }, + "tags": { + "tag1": "str" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/azuresentinel.azure-sentinel-solution-ciscoumbrella", + "name": "azuresentinel.azure-sentinel-solution-ciscoumbrella", + "type": "Microsoft.SecurityInsights/contenttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "4465ebde-c381-45d7-af08-7d818072a11c", + "packageKind": "Solution", + "packageId": "package id", + "contentKind": "AnalyticsRule", + "version": "1.0.1", + "displayName": "API Protection workbook template", + "source": { + "kind": "Solution", + "name": "CiscoUmbrella", + "sourceId": "azuresentinel.azure-sentinel-solution-ciscoumbrella" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfeab2-9ae0-4464-9919-dccaee2e48f0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/contentPackages/azuresentinel.azure-sentinel-solution-ciscoumbrella", + "name": "azuresentinel.azure-sentinel-solution-ciscoumbrella", + "type": "Microsoft.SecurityInsights/contenttemplates", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "contentId": "4465ebde-c381-45d7-af08-7d818072a11c", + "packageKind": "Solution", + "packageId": "package id", + "contentKind": "AnalyticsRule", + "version": "1.0.1", + "displayName": "API Protection workbook template", + "source": { + "kind": "Solution", + "name": "CiscoUmbrella", + "sourceId": "azuresentinel.azure-sentinel-solution-ciscoumbrella" + }, + "author": { + "name": "Microsoft", + "email": "support@microsoft.com" + }, + "support": { + "tier": "Microsoft", + "name": "Microsoft Corporation", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/" + }, + "dependencies": { + "criteria": [ + { + "contentId": "strDataConnector", + "kind": "DataConnector", + "version": "2.0.0" + }, + { + "contentId": "str-Parser", + "kind": "Parser", + "version": "2.0.0" + } + ], + "operator": "AND" + }, + "providers": [ + "Microsoft" + ], + "categories": { + "domains": [ + "Security - Cloud Security" + ], + "verticals": null + }, + "firstPublishDate": "2022-04-01" + }, + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-27T21:53:29.0928001Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-27T21:53:29.0928001Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json new file mode 100644 index 000000000000..9ec09f77bd1f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectory.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "AzureActiveDirectory", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json new file mode 100644 index 000000000000..9ec09f77bd1f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoAuthorization.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "AzureActiveDirectory", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json new file mode 100644 index 000000000000..9ec09f77bd1f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureActiveDirectoryNoLicense.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "AzureActiveDirectory", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json new file mode 100644 index 000000000000..4061888345c5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsAzureSecurityCenter.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "AzureSecurityCenter", + "properties": { + "subscriptionId": "c0688291-89d7-4bed-87a2-a7b1bff43f4c" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json new file mode 100644 index 000000000000..f7cae697c54c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsDynamics365.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "Dynamics365", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsIoT.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsIoT.json new file mode 100644 index 000000000000..1f2ec4f8851d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsIoT.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "IOT", + "properties": { + "subscriptionId": "c0688291-89d7-4bed-87a2-a7b1bff43f4c" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json new file mode 100644 index 000000000000..e44d41c47730 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMdatp.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "MicrosoftCloudAppSecurity", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json new file mode 100644 index 000000000000..e44d41c47730 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftCloudAppSecurity.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "MicrosoftCloudAppSecurity", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json new file mode 100644 index 000000000000..0eb8159cd1cc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftPurviewInformationProtection.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "MicrosoftPurviewInformationProtection", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json new file mode 100644 index 000000000000..bb594e628632 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatIntelligence.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "MicrosoftThreatIntelligence", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json new file mode 100644 index 000000000000..c44a4f6acb2b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsMicrosoftThreatProtection.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "MicrosoftThreatProtection", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json new file mode 100644 index 000000000000..af960771d653 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOffice365Project.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "Office365Project", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json new file mode 100644 index 000000000000..8b5d57d7a617 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficeATP.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "OfficeATP", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json new file mode 100644 index 000000000000..fbe81d7c3124 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficeIRM.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "OfficeIRM", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json new file mode 100644 index 000000000000..50704923a25a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsOfficePowerBI.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "OfficePowerBI", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json new file mode 100644 index 000000000000..407bf3f1f77a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligence.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "ThreatIntelligence", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json new file mode 100644 index 000000000000..e72a633ad21f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CheckRequirementsThreatIntelligenceTaxii.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "DataConnectorsCheckRequirements": { + "kind": "ThreatIntelligenceTaxii", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8" + } + } + }, + "responses": { + "200": { + "body": { + "authorizationState": "Valid", + "licenseState": "Valid" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/ConnectAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/ConnectAPIPolling.json new file mode 100644 index 000000000000..d804522cc167 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/ConnectAPIPolling.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "connectBody": { + "kind": "APIKey", + "apiKey": "123456789", + "requestConfigUserInputValues": [ + { + "displayText": "Organization Name", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "somePlaceHolderValue", + "requestObjectKey": "apiEndpoint" + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json new file mode 100644 index 000000000000..c1b47d080694 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/ConnectAPIPollingV2Logs.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "connectBody": { + "kind": "APIKey", + "apiKey": "123456789", + "dataCollectionEndpoint": "https://test.eastus.ingest.monitor.azure.com", + "dataCollectionRuleImmutableId": "dcr-34adsj9o7d6f9de204478b9cgb43b631", + "outputStream": "Custom-MyTableRawData", + "requestConfigUserInputValues": [ + { + "displayText": "Organization Name", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "somePlaceHolderValue", + "requestObjectKey": "apiEndpoint" + } + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateAPIPolling.json new file mode 100644 index 000000000000..851067895e53 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateAPIPolling.json @@ -0,0 +1,368 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "dataConnector": { + "kind": "APIPolling", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueriesTableName": "GitHubAuditLogPolling_CL", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "{{graphQueriesTableName}}\n | take 10 " + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "SentinelKindsV2", + "value": [] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "parameters": { + "enable": "true", + "userRequestPlaceHoldersInput": [ + { + "displayText": "Organization Name", + "requestObjectKey": "apiEndpoint", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "" + } + ] + }, + "type": "APIKey" + } + ] + } + ] + }, + "pollingConfig": { + "auth": { + "authType": "APIKey", + "apiKeyIdentifier": "token", + "apiKeyName": "Authorization" + }, + "request": { + "apiEndpoint": "https://api.github.com/organizations/{{placeHolder1}}/audit-log", + "rateLimitQps": 50, + "queryWindowInMin": 15, + "httpMethod": "Get", + "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", + "retryCount": 2, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" + } + }, + "paging": { + "pagingType": "LinkHeader", + "pageSizeParaName": "per_page" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "APIPolling", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueriesTableName": "GitHubAuditLogPolling_CL", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "{{graphQueriesTableName}}\n | take 10 " + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "SentinelKindsV2", + "value": [] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "parameters": { + "enable": "true", + "userRequestPlaceHoldersInput": [ + { + "displayText": "Organization Name", + "requestObjectKey": "apiEndpoint", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "" + } + ] + }, + "type": "APIKey" + } + ] + } + ] + }, + "pollingConfig": { + "auth": { + "authType": "APIKey", + "apiKeyIdentifier": "token", + "apiKeyName": "Authorization" + }, + "request": { + "apiEndpoint": "https://api.github.com/organizations/{{placeHolder1}}/audit-log", + "rateLimitQps": 50, + "queryWindowInMin": 15, + "httpMethod": "Get", + "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", + "retryCount": 2, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" + } + }, + "paging": { + "pagingType": "LinkHeader", + "pageSizeParaName": "per_page" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "APIPolling", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueriesTableName": "GitHubAuditLogPolling_CL", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "{{graphQueriesTableName}}\n | take 10 " + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "SentinelKindsV2", + "value": [] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "parameters": { + "enable": "true", + "userRequestPlaceHoldersInput": [ + { + "displayText": "Organization Name", + "requestObjectKey": "apiEndpoint", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "" + } + ] + }, + "type": "APIKey" + } + ] + } + ] + }, + "pollingConfig": { + "auth": { + "authType": "APIKey", + "apiKeyIdentifier": "token", + "apiKeyName": "Authorization" + }, + "request": { + "apiEndpoint": "https://api.github.com/organizations/{{placeHolder1}}/audit-log", + "rateLimitQps": 50, + "queryWindowInMin": 15, + "httpMethod": "Get", + "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", + "retryCount": 2, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" + } + }, + "paging": { + "pagingType": "LinkHeader", + "pageSizeParaName": "per_page" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json new file mode 100644 index 000000000000..f35d42cec0f8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateDynamics365DataConnetor.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c2541efb-c9a6-47fe-9501-87d1017d1512", + "dataConnector": { + "kind": "Dynamics365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "dynamics365CdsActivities": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "c2541efb-c9a6-47fe-9501-87d1017d1512", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Dynamics365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "dynamics365CdsActivities": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "c2541efb-c9a6-47fe-9501-87d1017d1512", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Dynamics365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "dynamics365CdsActivities": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateGenericUI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateGenericUI.json new file mode 100644 index 000000000000..4e6b4bef891f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateGenericUI.json @@ -0,0 +1,437 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "dataConnector": { + "kind": "GenericUI", + "properties": { + "connectorUiConfig": { + "title": "Qualys Vulnerability Management (CCP DEMO)", + "publisher": "Qualys", + "descriptionMarkdown": "The [Qualys Vulnerability Management (VM)](https://www.qualys.com/apps/vulnerability-management/) data connector provides the capability to ingest vulnerability host detection data into Azure Sentinel through the Qualys API. The connector provides visibility into host detection data from vulerability scans. This connector provides Azure Sentinel the capability to view dashboards, create custom alerts, and improve investigation ", + "graphQueriesTableName": "QualysHostDetection_CL", + "graphQueries": [ + { + "metricName": "Total data received", + "legend": "{{graphQueriesTableName}}", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "Top 10 Vulerabilities detected", + "query": "{{graphQueriesTableName}}\n | mv-expand todynamic(Detections_s)\n | extend Vulnerability = tostring(Detections_s.Results)\n | summarize count() by Vulnerability\n | top 10 by count_" + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "{{graphQueriesTableName}}\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "Qualys API Key", + "description": "A Qualys VM API username and password is required. [See the documentation to learn more about Qualys VM API](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf)." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to Qualys VM to pull its logs into Azure Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details." + }, + { + "title": "", + "description": ">**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Qualys VM API**\n\n1. Log into the Qualys Vulnerability Management console with an administrator account, select the **Users** tab and the **Users** subtab. \n2. Click on the **New** drop-down menu and select **Users..**\n3. Create a username and password for the API account. \n4. In the **User Roles** tab, ensure the account role is set to **Manager** and access is allowed to **GUI** and **API**\n4. Log out of the administrator account and log into the console with the new API credentials for validation, then log out of the API account. \n5. Log back into the console using an administrator account and modify the API accounts User Roles, removing access to **GUI**. \n6. Save all changes." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Qualys VM connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Qualys VM API Authorization Key(s), readily available.", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Qualys VM connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinelqualysvmazuredeploy)\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password** , update the **URI**, and any additional URI **Filter Parameters** (each filter should be separated by an \"&\" symbol, no spaces.) \n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348) -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format. \n - The default **Time Interval** is set to pull the last five (5) minutes of data. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly (in the function.json file, post deployment) to prevent overlapping data ingestion. \n> - Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Quayls VM connector manually with Azure Functions." + }, + { + "title": "", + "description": "**1. Create a Function App**\n\n1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp), and select **+ Add**.\n2. In the **Basics** tab, ensure Runtime stack is set to **Powershell Core**. \n3. In the **Hosting** tab, ensure the **Consumption (Serverless)** plan type is selected.\n4. Make other preferrable configuration changes, if needed, then click **Create**." + }, + { + "title": "", + "description": "**2. Import Function App Code**\n\n1. In the newly created Function App, select **Functions** on the left pane and click **+ New Function**.\n2. Select **Timer Trigger**.\n3. Enter a unique Function **Name** and leave the default cron schedule of every 5 minutes, then click **Create**.\n5. Click on **Code + Test** on the left pane. \n6. Copy the [Function App Code](https://aka.ms/sentinelqualysvmazurefunctioncode) and paste into the Function App `run.ps1` editor.\n7. Click **Save**." + }, + { + "title": "", + "description": "**3. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n2. In the **Application settings** tab, select **+ New application setting**.\n3. Add each of the following seven (7) application settings individually, with their respective string values (case-sensitive): \n\t\tapiUsername\n\t\tapiPassword\n\t\tworkspaceID\n\t\tworkspaceKey\n\t\turi\n\t\tfilterParameters\n\t\ttimeInterval\n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348). The `uri` value must follow the following schema: `https:///api/2.0/fo/asset/host/vm/detection/?action=list&vm_processed_after=` -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format.\n> - Add any additional filter parameters, for the `filterParameters` variable, that need to be appended to the URI. Each parameter should be seperated by an \"&\" symbol and should not include any spaces.\n> - Set the `timeInterval` (in minutes) to the value of `5` to correspond to the Timer Trigger of every `5` minutes. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly to prevent overlapping data ingestion.\n> - Note: If using Azure Key Vault, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details.\n4. Once all application settings have been entered, click **Save**." + }, + { + "title": "", + "description": "**4. Configure the host.json**.\n\nDue to the potentially large amount of Qualys host detection data being ingested, it can cause the execution time to surpass the default Function App timeout of five (5) minutes. Increase the default timeout duration to the maximum of ten (10) minutes, under the Consumption Plan, to allow more time for the Function App to execute.\n\n1. In the Function App, select the Function App Name and select the **App Service Editor** blade.\n2. Click **Go** to open the editor, then select the **host.json** file under the **wwwroot** directory.\n3. Add the line `\"functionTimeout\": \"00:10:00\",` above the `managedDependancy` line \n4. Ensure **SAVED** appears on the top right corner of the editor, then exit the editor.\n\n> NOTE: If a longer timeout duration is required, consider upgrading to an [App Service Plan](https://docs.microsoft.com/azure/azure-functions/functions-scale#timeout)" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "GenericUI", + "properties": { + "connectorUiConfig": { + "title": "Qualys Vulnerability Management (CCP DEMO)", + "publisher": "Qualys", + "descriptionMarkdown": "The [Qualys Vulnerability Management (VM)](https://www.qualys.com/apps/vulnerability-management/) data connector provides the capability to ingest vulnerability host detection data into Azure Sentinel through the Qualys API. The connector provides visibility into host detection data from vulerability scans. This connector provides Azure Sentinel the capability to view dashboards, create custom alerts, and improve investigation ", + "graphQueriesTableName": "QualysHostDetection_CL", + "graphQueries": [ + { + "metricName": "Total data received", + "legend": "{{graphQueriesTableName}}", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "Top 10 Vulerabilities detected", + "query": "{{graphQueriesTableName}}\n | mv-expand todynamic(Detections_s)\n | extend Vulnerability = tostring(Detections_s.Results)\n | summarize count() by Vulnerability\n | top 10 by count_" + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "{{graphQueriesTableName}}\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "Qualys API Key", + "description": "A Qualys VM API username and password is required. [See the documentation to learn more about Qualys VM API](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf)." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to Qualys VM to pull its logs into Azure Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details." + }, + { + "title": "", + "description": ">**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Qualys VM API**\n\n1. Log into the Qualys Vulnerability Management console with an administrator account, select the **Users** tab and the **Users** subtab. \n2. Click on the **New** drop-down menu and select **Users..**\n3. Create a username and password for the API account. \n4. In the **User Roles** tab, ensure the account role is set to **Manager** and access is allowed to **GUI** and **API**\n4. Log out of the administrator account and log into the console with the new API credentials for validation, then log out of the API account. \n5. Log back into the console using an administrator account and modify the API accounts User Roles, removing access to **GUI**. \n6. Save all changes." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Qualys VM connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Qualys VM API Authorization Key(s), readily available.", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Qualys VM connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinelqualysvmazuredeploy)\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password** , update the **URI**, and any additional URI **Filter Parameters** (each filter should be separated by an \"&\" symbol, no spaces.) \n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348) -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format. \n - The default **Time Interval** is set to pull the last five (5) minutes of data. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly (in the function.json file, post deployment) to prevent overlapping data ingestion. \n> - Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Quayls VM connector manually with Azure Functions." + }, + { + "title": "", + "description": "**1. Create a Function App**\n\n1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp), and select **+ Add**.\n2. In the **Basics** tab, ensure Runtime stack is set to **Powershell Core**. \n3. In the **Hosting** tab, ensure the **Consumption (Serverless)** plan type is selected.\n4. Make other preferrable configuration changes, if needed, then click **Create**." + }, + { + "title": "", + "description": "**2. Import Function App Code**\n\n1. In the newly created Function App, select **Functions** on the left pane and click **+ New Function**.\n2. Select **Timer Trigger**.\n3. Enter a unique Function **Name** and leave the default cron schedule of every 5 minutes, then click **Create**.\n5. Click on **Code + Test** on the left pane. \n6. Copy the [Function App Code](https://aka.ms/sentinelqualysvmazurefunctioncode) and paste into the Function App `run.ps1` editor.\n7. Click **Save**." + }, + { + "title": "", + "description": "**3. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n2. In the **Application settings** tab, select **+ New application setting**.\n3. Add each of the following seven (7) application settings individually, with their respective string values (case-sensitive): \n\t\tapiUsername\n\t\tapiPassword\n\t\tworkspaceID\n\t\tworkspaceKey\n\t\turi\n\t\tfilterParameters\n\t\ttimeInterval\n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348). The `uri` value must follow the following schema: `https:///api/2.0/fo/asset/host/vm/detection/?action=list&vm_processed_after=` -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format.\n> - Add any additional filter parameters, for the `filterParameters` variable, that need to be appended to the URI. Each parameter should be seperated by an \"&\" symbol and should not include any spaces.\n> - Set the `timeInterval` (in minutes) to the value of `5` to correspond to the Timer Trigger of every `5` minutes. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly to prevent overlapping data ingestion.\n> - Note: If using Azure Key Vault, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details.\n4. Once all application settings have been entered, click **Save**." + }, + { + "title": "", + "description": "**4. Configure the host.json**.\n\nDue to the potentially large amount of Qualys host detection data being ingested, it can cause the execution time to surpass the default Function App timeout of five (5) minutes. Increase the default timeout duration to the maximum of ten (10) minutes, under the Consumption Plan, to allow more time for the Function App to execute.\n\n1. In the Function App, select the Function App Name and select the **App Service Editor** blade.\n2. Click **Go** to open the editor, then select the **host.json** file under the **wwwroot** directory.\n3. Add the line `\"functionTimeout\": \"00:10:00\",` above the `managedDependancy` line \n4. Ensure **SAVED** appears on the top right corner of the editor, then exit the editor.\n\n> NOTE: If a longer timeout duration is required, consider upgrading to an [App Service Plan](https://docs.microsoft.com/azure/azure-functions/functions-scale#timeout)" + } + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "GenericUI", + "properties": { + "connectorUiConfig": { + "title": "Qualys Vulnerability Management (CCP DEMO)", + "publisher": "Qualys", + "descriptionMarkdown": "The [Qualys Vulnerability Management (VM)](https://www.qualys.com/apps/vulnerability-management/) data connector provides the capability to ingest vulnerability host detection data into Azure Sentinel through the Qualys API. The connector provides visibility into host detection data from vulerability scans. This connector provides Azure Sentinel the capability to view dashboards, create custom alerts, and improve investigation ", + "graphQueriesTableName": "QualysHostDetection_CL", + "graphQueries": [ + { + "metricName": "Total data received", + "legend": "{{graphQueriesTableName}}", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "Top 10 Vulerabilities detected", + "query": "{{graphQueriesTableName}}\n | mv-expand todynamic(Detections_s)\n | extend Vulnerability = tostring(Detections_s.Results)\n | summarize count() by Vulnerability\n | top 10 by count_" + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "{{graphQueriesTableName}}\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "Qualys API Key", + "description": "A Qualys VM API username and password is required. [See the documentation to learn more about Qualys VM API](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf)." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to Qualys VM to pull its logs into Azure Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details." + }, + { + "title": "", + "description": ">**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Qualys VM API**\n\n1. Log into the Qualys Vulnerability Management console with an administrator account, select the **Users** tab and the **Users** subtab. \n2. Click on the **New** drop-down menu and select **Users..**\n3. Create a username and password for the API account. \n4. In the **User Roles** tab, ensure the account role is set to **Manager** and access is allowed to **GUI** and **API**\n4. Log out of the administrator account and log into the console with the new API credentials for validation, then log out of the API account. \n5. Log back into the console using an administrator account and modify the API accounts User Roles, removing access to **GUI**. \n6. Save all changes." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Qualys VM connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Qualys VM API Authorization Key(s), readily available.", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Qualys VM connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinelqualysvmazuredeploy)\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password** , update the **URI**, and any additional URI **Filter Parameters** (each filter should be separated by an \"&\" symbol, no spaces.) \n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348) -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format. \n - The default **Time Interval** is set to pull the last five (5) minutes of data. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly (in the function.json file, post deployment) to prevent overlapping data ingestion. \n> - Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Quayls VM connector manually with Azure Functions." + }, + { + "title": "", + "description": "**1. Create a Function App**\n\n1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp), and select **+ Add**.\n2. In the **Basics** tab, ensure Runtime stack is set to **Powershell Core**. \n3. In the **Hosting** tab, ensure the **Consumption (Serverless)** plan type is selected.\n4. Make other preferrable configuration changes, if needed, then click **Create**." + }, + { + "title": "", + "description": "**2. Import Function App Code**\n\n1. In the newly created Function App, select **Functions** on the left pane and click **+ New Function**.\n2. Select **Timer Trigger**.\n3. Enter a unique Function **Name** and leave the default cron schedule of every 5 minutes, then click **Create**.\n5. Click on **Code + Test** on the left pane. \n6. Copy the [Function App Code](https://aka.ms/sentinelqualysvmazurefunctioncode) and paste into the Function App `run.ps1` editor.\n7. Click **Save**." + }, + { + "title": "", + "description": "**3. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n2. In the **Application settings** tab, select **+ New application setting**.\n3. Add each of the following seven (7) application settings individually, with their respective string values (case-sensitive): \n\t\tapiUsername\n\t\tapiPassword\n\t\tworkspaceID\n\t\tworkspaceKey\n\t\turi\n\t\tfilterParameters\n\t\ttimeInterval\n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348). The `uri` value must follow the following schema: `https:///api/2.0/fo/asset/host/vm/detection/?action=list&vm_processed_after=` -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format.\n> - Add any additional filter parameters, for the `filterParameters` variable, that need to be appended to the URI. Each parameter should be seperated by an \"&\" symbol and should not include any spaces.\n> - Set the `timeInterval` (in minutes) to the value of `5` to correspond to the Timer Trigger of every `5` minutes. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly to prevent overlapping data ingestion.\n> - Note: If using Azure Key Vault, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details.\n4. Once all application settings have been entered, click **Save**." + }, + { + "title": "", + "description": "**4. Configure the host.json**.\n\nDue to the potentially large amount of Qualys host detection data being ingested, it can cause the execution time to surpass the default Function App timeout of five (5) minutes. Increase the default timeout duration to the maximum of ten (10) minutes, under the Consumption Plan, to allow more time for the Function App to execute.\n\n1. In the Function App, select the Function App Name and select the **App Service Editor** blade.\n2. Click **Go** to open the editor, then select the **host.json** file under the **wwwroot** directory.\n3. Add the line `\"functionTimeout\": \"00:10:00\",` above the `managedDependancy` line \n4. Ensure **SAVED** appears on the top right corner of the editor, then exit the editor.\n\n> NOTE: If a longer timeout duration is required, consider upgrading to an [App Service Plan](https://docs.microsoft.com/azure/azure-functions/functions-scale#timeout)" + } + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json new file mode 100644 index 000000000000..4834347bbeb4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateGoogleCloudPlatform.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1", + "dataConnector": { + "kind": "GCP", + "properties": { + "connectorDefinitionName": "GcpConnector", + "auth": { + "serviceAccountEmail": "sentinel-service-account@project-id.iam.gserviceaccount.com", + "projectNumber": "123456789012", + "workloadIdentityProviderId": "sentinel-identity-provider", + "type": "GCP" + }, + "request": { + "projectId": "project-id", + "subscriptionNames": [ + "sentinel-subscription" + ] + }, + "dcrConfig": { + "dataCollectionEndpoint": "https://microsoft-sentinel-datacollectionendpoint-123m.westeurope-1.ingest.monitor.azure.com", + "dataCollectionRuleImmutableId": "dcr-de21b053bd5a44beb99a256c9db85023", + "streamName": "SENTINEL_GCP_AUDIT_LOGS" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/GCP_afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "GCP", + "properties": { + "connectorDefinitionName": "GcpConnector", + "auth": { + "serviceAccountEmail": "sentinel-service-account@project-id.iam.gserviceaccount.com", + "projectNumber": "123456789012", + "workloadIdentityProviderId": "sentinel-identity-provider", + "type": "GCP" + }, + "request": { + "projectId": "project-id", + "subscriptionNames": [ + "sentinel-subscription" + ] + }, + "dcrConfig": { + "dataCollectionEndpoint": "https://microsoft-sentinel-datacollectionendpoint-123m.westeurope-1.ingest.monitor.azure.com", + "dataCollectionRuleImmutableId": "dcr-de21b053bd5a44beb99a256c9db85023", + "streamName": "SENTINEL_GCP_AUDIT_LOGS" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/GCP_afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "GCP", + "properties": { + "connectorDefinitionName": "GcpConnector", + "auth": { + "serviceAccountEmail": "sentinel-service-account@project-id.iam.gserviceaccount.com", + "projectNumber": "123456789012", + "workloadIdentityProviderId": "sentinel-identity-provider", + "type": "GCP" + }, + "request": { + "projectId": "project-id", + "subscriptionNames": [ + "sentinel-subscription" + ] + }, + "dcrConfig": { + "dataCollectionEndpoint": "https://microsoft-sentinel-datacollectionendpoint-123m.westeurope-1.ingest.monitor.azure.com", + "dataCollectionRuleImmutableId": "dcr-de21b053bd5a44beb99a256c9db85023", + "streamName": "SENTINEL_GCP_AUDIT_LOGS" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json new file mode 100644 index 000000000000..818f21b9b257 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftPurviewInformationProtectionDataConnetor.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "MicrosoftPurviewInformationProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftPurviewInformationProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftPurviewInformationProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json new file mode 100644 index 000000000000..81ce849d43ae --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftThreatIntelligenceDataConnector.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "dataConnector": { + "kind": "MicrosoftThreatIntelligence", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "dataTypes": { + "microsoftEmergingThreatFeed": { + "state": "Enabled", + "lookbackPeriod": "1970-01-01T00:00:00.000Z" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "d12423f6-a60b-4ca5-88c0-feb1a182d0f0", + "kind": "MicrosoftThreatIntelligence", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "dataTypes": { + "microsoftEmergingThreatFeed": { + "state": "Enabled", + "lookbackPeriod": "01/01/1970 00:00:00" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "d12423f6-a60b-4ca5-88c0-feb1a182d0f0", + "kind": "MicrosoftThreatIntelligence", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "dataTypes": { + "microsoftEmergingThreatFeed": { + "state": "Enabled", + "lookbackPeriod": "01/01/1970 00:00:00" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json new file mode 100644 index 000000000000..cfa375456b7b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateMicrosoftThreatProtectionDataConnetor.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "MicrosoftThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "178265c4-3136-4ff6-8ed1-b5b62b4cb5f5", + "dataTypes": { + "incidents": { + "state": "Disabled" + }, + "alerts": { + "state": "Enabled" + } + }, + "filteredProviders": { + "alerts": [ + "microsoftDefenderForCloudApps" + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/595c870a-5b74-4a23-984c-9ddba29cefe3", + "name": "595c870a-5b74-4a23-984c-9ddba29cefe3", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftThreatProtection", + "etag": "2b61bd0c-62b4-4968-8f9a-71b91be61127", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "incidents": { + "state": "Disabled55" + }, + "alerts": { + "state": "Enabled" + } + }, + "filteredProviders": { + "alerts": [ + "microsoftDefenderForCloudApps" + ] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/595c870a-5b74-4a23-984c-9ddba29cefe3", + "name": "595c870a-5b74-4a23-984c-9ddba29cefe3", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftThreatProtection", + "etag": "2b61bd0c-62b4-4968-8f9a-71b91be61127", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "incidents": { + "state": "Disabled" + }, + "alerts": { + "state": "Enabled" + } + }, + "filteredProviders": { + "alerts": [ + "microsoftDefenderForCloudApps" + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json new file mode 100644 index 000000000000..6e81b5495850 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOffice365ProjectDataConnetor.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "Office365Project", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365Project", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365Project", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json new file mode 100644 index 000000000000..bd8c7495906d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOfficeDataConnetor.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + }, + "teams": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + }, + "teams": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + }, + "teams": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json new file mode 100644 index 000000000000..73e032bbd49b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateOfficePowerBIDataConnector.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "OfficePowerBI", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficePowerBI", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficePowerBI", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json new file mode 100644 index 000000000000..e0b0ae2ed6c8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateThreatIntelligenceDataConnector.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "kind": "ThreatIntelligence", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "tipLookbackPeriod": "2020-01-01T13:00:30.123Z", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "tipLookbackPeriod": "2020-01-01T13:00:30.123Z", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "tipLookbackPeriod": "2020-01-01T13:00:30.123Z", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json new file mode 100644 index 000000000000..e42faf2077c2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/CreateThreatIntelligenceTaxiiDataConnector.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "dataConnector": { + "etag": "d12423f6-a60b-4ca5-88c0-feb1a182d0f0", + "kind": "ThreatIntelligenceTaxii", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "taxiiServer": "https://limo.anomali.com/api/v1/taxii2/feeds", + "collectionId": "135", + "workspaceId": "dd124572-4962-4495-9bd2-9dade12314b4", + "friendlyName": "testTaxii", + "userName": "--", + "password": "--", + "taxiiLookbackPeriod": "2020-01-01T13:00:30.123Z", + "pollingFrequency": "OnceADay", + "dataTypes": { + "taxiiClient": { + "state": "Enabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "d12423f6-a60b-4ca5-88c0-feb1a182d0f0", + "kind": "ThreatIntelligenceTaxii", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "taxiiServer": "https://limo.anomali.com/api/v1/taxii2/feeds", + "collectionId": "135", + "workspaceId": "28e5f051-34cb-4208-9037-693e5342a871", + "friendlyName": "testTaxii", + "userName": null, + "password": null, + "taxiiLookbackPeriod": "2020-01-01T13:00:30.123Z", + "pollingFrequency": "OnceADay", + "dataTypes": { + "taxiiClient": { + "state": "Enabled" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "d12423f6-a60b-4ca5-88c0-feb1a182d0f0", + "kind": "ThreatIntelligenceTaxii", + "properties": { + "tenantId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "taxiiServer": "https://limo.anomali.com/api/v1/taxii2/feeds", + "collectionId": "135", + "workspaceId": "28e5f051-34cb-4208-9037-693e5342a871", + "friendlyName": "testTaxii", + "userName": null, + "password": null, + "taxiiLookbackPeriod": "2020-01-01T13:00:30.123Z", + "pollingFrequency": "OnceADay", + "dataTypes": { + "taxiiClient": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteAPIPolling.json new file mode 100644 index 000000000000..785437c77d5e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteAPIPolling.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteGenericUI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteGenericUI.json new file mode 100644 index 000000000000..785437c77d5e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteGenericUI.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json new file mode 100644 index 000000000000..12b832fa4704 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteGoogleCloudPlatform.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json new file mode 100644 index 000000000000..1da9cadfb29e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteMicrosoftPurviewInformationProtectionDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json new file mode 100644 index 000000000000..a33c44998377 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteMicrosoftThreatIntelligenceDataConnector.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json new file mode 100644 index 000000000000..1da9cadfb29e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOffice365ProjectDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json new file mode 100644 index 000000000000..1da9cadfb29e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOfficeDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json new file mode 100644 index 000000000000..1da9cadfb29e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DeleteOfficePowerBIDataConnetor.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DisconnectAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DisconnectAPIPolling.json new file mode 100644 index 000000000000..7061822057bb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/DisconnectAPIPolling.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "disconnectBody": {} + }, + "responses": { + "200": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAPIPolling.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAPIPolling.json new file mode 100644 index 000000000000..6d30afa74e41 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAPIPolling.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "APIPolling", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "customImage": "The image connector content", + "graphQueriesTableName": "GitHubAuditLogPolling_CL", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "{{graphQueriesTableName}}\n | take 10 " + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "SentinelKindsV2", + "value": [] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "parameters": { + "enable": "true", + "userRequestPlaceHoldersInput": [ + { + "displayText": "Organization Name", + "requestObjectKey": "apiEndpoint", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "" + } + ] + }, + "type": "APIKey" + } + ] + } + ] + }, + "pollingConfig": { + "auth": { + "authType": "APIKey", + "apiKeyIdentifier": "token", + "apiKeyName": "Authorization" + }, + "request": { + "apiEndpoint": "https://api.github.com/organizations/{{placeHolder1}}/audit-log", + "rateLimitQps": 50, + "queryWindowInMin": 15, + "httpMethod": "Get", + "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", + "retryCount": 2, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" + } + }, + "paging": { + "pagingType": "LinkHeader", + "pageSizeParaName": "per_page" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json new file mode 100644 index 000000000000..a609d02d0a86 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAmazonWebServicesCloudTrailById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "AmazonWebServicesCloudTrail", + "properties": { + "awsRoleArn": "myAwsRoleArn", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json new file mode 100644 index 000000000000..32052dabf09c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAmazonWebServicesS3ById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "afef3743-0c88-469c-84ff-ca2e87dc1e48" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "afef3743-0c88-469c-84ff-ca2e87dc1e48", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "AmazonWebServicesS3", + "properties": { + "destinationTable": "AWSVPCFlow", + "roleArn": "arn:aws:iam::072643944673:role/RoleName", + "sqsUrls": [ + "https://sqs.us-west-1.amazonaws.com/111111111111/sqsTestName" + ], + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json new file mode 100644 index 000000000000..58c54a3c4290 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureActiveDirectoryById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "name": "f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureActiveDirectory", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json new file mode 100644 index 000000000000..9b2f426f1b06 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureAdvancedThreatProtectionById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "07e42cb3-e658-4e90-801c-efa0f29d3d44" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/07e42cb3-e658-4e90-801c-efa0f29d3d44", + "name": "07e42cb3-e658-4e90-801c-efa0f29d3d44", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureAdvancedThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json new file mode 100644 index 000000000000..f6ddd486680e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetAzureSecurityCenterById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureSecurityCenter", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "subscriptionId": "c0688291-89d7-4bed-87a2-a7b1bff43f4c", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetDataConnectors.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetDataConnectors.json new file mode 100644 index 000000000000..20a31a77c02c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetDataConnectors.json @@ -0,0 +1,508 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "name": "763f9fa1-c2d3-4fa2-93e9-bccd4899aa12", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureSecurityCenter", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c39bb458-02a7-4b3f-b0c8-71a1d2692652", + "name": "c39bb458-02a7-4b3f-b0c8-71a1d2692652", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligenceTaxii", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "workspaceId": "8b014a77-4695-4ef4-96bb-6623afb121a2", + "friendlyName": "My TI Taxii Connector", + "taxiiServer": "https://mytaxiiserver.com/taxiing/v2/api", + "collectionId": "e0b1f32d-1188-48f7-a7a3-de71924e4b5e", + "userName": "", + "password": "", + "pollingFrequency": "OnceAMinute", + "dataTypes": { + "taxiiClient": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "name": "f0cd27d2-5f03-4c06-ba31-d2dc82dcb51d", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureActiveDirectory", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + }, + "teams": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/b96d014d-b5c2-4a01-9aba-a8058f629d42", + "name": "b96d014d-b5c2-4a01-9aba-a8058f629d42", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftCloudAppSecurity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + }, + "discoveryLogs": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/07e42cb3-e658-4e90-801c-efa0f29d3d44", + "name": "07e42cb3-e658-4e90-801c-efa0f29d3d44", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "AzureAdvancedThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "AmazonWebServicesCloudTrail", + "properties": { + "awsRoleArn": "myAwsRoleArn", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "afef3743-0c88-469c-84ff-ca2e87dc1e48", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "AmazonWebServicesS3", + "properties": { + "destinationTable": "AWSVPCFlow", + "roleArn": "arn:aws:iam::072643944673:role/RoleName", + "sqsUrls": [ + "https://sqs.us-west-1.amazonaws.com/111111111111/sqsTestName" + ], + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "name": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftDefenderAdvancedThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficeATP", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365Project", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficePowerBI", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "c2541efb-c9a6-47fe-9501-87d1017d1512", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Dynamics365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "dynamics365CdsActivities": { + "state": "Enabled" + } + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "GenericUI", + "properties": { + "connectorUiConfig": { + "title": "Qualys Vulnerability Management (CCP DEMO)", + "publisher": "Qualys", + "descriptionMarkdown": "The [Qualys Vulnerability Management (VM)](https://www.qualys.com/apps/vulnerability-management/) data connector provides the capability to ingest vulnerability host detection data into Azure Sentinel through the Qualys API. The connector provides visibility into host detection data from vulerability scans. This connector provides Azure Sentinel the capability to view dashboards, create custom alerts, and improve investigation ", + "customImage": "The image connector content", + "graphQueriesTableName": "QualysHostDetection_CL", + "graphQueries": [ + { + "metricName": "Total data received", + "legend": "{{graphQueriesTableName}}", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "Top 10 Vulerabilities detected", + "query": "{{graphQueriesTableName}}\n | mv-expand todynamic(Detections_s)\n | extend Vulnerability = tostring(Detections_s.Results)\n | summarize count() by Vulnerability\n | top 10 by count_" + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "{{graphQueriesTableName}}\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "Qualys API Key", + "description": "A Qualys VM API username and password is required. [See the documentation to learn more about Qualys VM API](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf)." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to Qualys VM to pull its logs into Azure Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details." + }, + { + "title": "", + "description": ">**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Qualys VM API**\n\n1. Log into the Qualys Vulnerability Management console with an administrator account, select the **Users** tab and the **Users** subtab. \n2. Click on the **New** drop-down menu and select **Users..**\n3. Create a username and password for the API account. \n4. In the **User Roles** tab, ensure the account role is set to **Manager** and access is allowed to **GUI** and **API**\n4. Log out of the administrator account and log into the console with the new API credentials for validation, then log out of the API account. \n5. Log back into the console using an administrator account and modify the API accounts User Roles, removing access to **GUI**. \n6. Save all changes." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Qualys VM connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Qualys VM API Authorization Key(s), readily available.", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Qualys VM connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinelqualysvmazuredeploy)\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password** , update the **URI**, and any additional URI **Filter Parameters** (each filter should be separated by an \"&\" symbol, no spaces.) \n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348) -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format. \n - The default **Time Interval** is set to pull the last five (5) minutes of data. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly (in the function.json file, post deployment) to prevent overlapping data ingestion. \n> - Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Quayls VM connector manually with Azure Functions." + }, + { + "title": "", + "description": "**1. Create a Function App**\n\n1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp), and select **+ Add**.\n2. In the **Basics** tab, ensure Runtime stack is set to **Powershell Core**. \n3. In the **Hosting** tab, ensure the **Consumption (Serverless)** plan type is selected.\n4. Make other preferrable configuration changes, if needed, then click **Create**." + }, + { + "title": "", + "description": "**2. Import Function App Code**\n\n1. In the newly created Function App, select **Functions** on the left pane and click **+ New Function**.\n2. Select **Timer Trigger**.\n3. Enter a unique Function **Name** and leave the default cron schedule of every 5 minutes, then click **Create**.\n5. Click on **Code + Test** on the left pane. \n6. Copy the [Function App Code](https://aka.ms/sentinelqualysvmazurefunctioncode) and paste into the Function App `run.ps1` editor.\n7. Click **Save**." + }, + { + "title": "", + "description": "**3. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n2. In the **Application settings** tab, select **+ New application setting**.\n3. Add each of the following seven (7) application settings individually, with their respective string values (case-sensitive): \n\t\tapiUsername\n\t\tapiPassword\n\t\tworkspaceID\n\t\tworkspaceKey\n\t\turi\n\t\tfilterParameters\n\t\ttimeInterval\n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348). The `uri` value must follow the following schema: `https:///api/2.0/fo/asset/host/vm/detection/?action=list&vm_processed_after=` -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format.\n> - Add any additional filter parameters, for the `filterParameters` variable, that need to be appended to the URI. Each parameter should be seperated by an \"&\" symbol and should not include any spaces.\n> - Set the `timeInterval` (in minutes) to the value of `5` to correspond to the Timer Trigger of every `5` minutes. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly to prevent overlapping data ingestion.\n> - Note: If using Azure Key Vault, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details.\n4. Once all application settings have been entered, click **Save**." + }, + { + "title": "", + "description": "**4. Configure the host.json**.\n\nDue to the potentially large amount of Qualys host detection data being ingested, it can cause the execution time to surpass the default Function App timeout of five (5) minutes. Increase the default timeout duration to the maximum of ten (10) minutes, under the Consumption Plan, to allow more time for the Function App to execute.\n\n1. In the Function App, select the Function App Name and select the **App Service Editor** blade.\n2. Click **Go** to open the editor, then select the **host.json** file under the **wwwroot** directory.\n3. Add the line `\"functionTimeout\": \"00:10:00\",` above the `managedDependancy` line \n4. Ensure **SAVED** appears on the top right corner of the editor, then exit the editor.\n\n> NOTE: If a longer timeout duration is required, consider upgrading to an [App Service Plan](https://docs.microsoft.com/azure/azure-functions/functions-scale#timeout)" + } + ] + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "APIPolling", + "properties": { + "connectorUiConfig": { + "title": "GitHub Enterprise Audit Log", + "publisher": "GitHub", + "descriptionMarkdown": "The GitHub audit log connector provides the capability to ingest GitHub logs into Azure Sentinel. By connecting GitHub audit logs into Azure Sentinel, you can view this data in workbooks, use it to create custom alerts, and improve your investigation process.", + "graphQueriesTableName": "GitHubAuditLogPolling_CL", + "graphQueries": [ + { + "metricName": "Total events received", + "legend": "GitHub audit log events", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "All logs", + "query": "{{graphQueriesTableName}}\n | take 10 " + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "SentinelKindsV2", + "value": [] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + } + ], + "customs": [ + { + "name": "GitHub API personal token Key", + "description": "You need access to GitHub personal token, the key should have 'admin:org' scope" + } + ] + }, + "instructionSteps": [ + { + "title": "Connect GitHub Enterprise Audit Log to Azure Sentinel", + "description": "Enable GitHub audit Logs. \n Follow [this](https://docs.github.com/en/github/authenticating-to-github/keeping-your-account-and-data-secure/creating-a-personal-access-token) to create or find your personal key", + "instructions": [ + { + "parameters": { + "enable": "true", + "userRequestPlaceHoldersInput": [ + { + "displayText": "Organization Name", + "requestObjectKey": "apiEndpoint", + "placeHolderName": "{{placeHolder1}}", + "placeHolderValue": "" + } + ] + }, + "type": "APIKey" + } + ] + } + ] + }, + "pollingConfig": { + "auth": { + "authType": "APIKey", + "apiKeyIdentifier": "token", + "apiKeyName": "Authorization" + }, + "request": { + "apiEndpoint": "https://api.github.com/organizations/{{placeHolder1}}/audit-log", + "rateLimitQps": 50, + "queryWindowInMin": 15, + "httpMethod": "Get", + "queryTimeFormat": "yyyy-MM-ddTHH:mm:ssZ", + "retryCount": 2, + "timeoutInSeconds": 60, + "headers": { + "Accept": "application/json", + "User-Agent": "Scuba" + }, + "queryParameters": { + "phrase": "created:{_QueryWindowStartTime}..{_QueryWindowEndTime}" + } + }, + "paging": { + "pagingType": "LinkHeader", + "pageSizeParaName": "per_page" + }, + "response": { + "eventsJsonPaths": [ + "$" + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json new file mode 100644 index 000000000000..0870b2eedd4f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetDynamics365DataConnectorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c2541efb-c9a6-47fe-9501-87d1017d1512" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "c2541efb-c9a6-47fe-9501-87d1017d1512", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Dynamics365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "dynamics365CdsActivities": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetGenericUI.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetGenericUI.json new file mode 100644 index 000000000000..bd3496fb68d3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetGenericUI.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "316ec55e-7138-4d63-ab18-90c8a60fd1c8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "name": "316ec55e-7138-4d63-ab18-90c8a60fd1c8", + "etag": "\"1a00b074-0000-0100-0000-606ef5bd0000\"", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "GenericUI", + "properties": { + "connectorUiConfig": { + "title": "Qualys Vulnerability Management (CCP DEMO)", + "publisher": "Qualys", + "descriptionMarkdown": "The [Qualys Vulnerability Management (VM)](https://www.qualys.com/apps/vulnerability-management/) data connector provides the capability to ingest vulnerability host detection data into Azure Sentinel through the Qualys API. The connector provides visibility into host detection data from vulerability scans. This connector provides Azure Sentinel the capability to view dashboards, create custom alerts, and improve investigation ", + "customImage": "The image connector content", + "graphQueriesTableName": "QualysHostDetection_CL", + "graphQueries": [ + { + "metricName": "Total data received", + "legend": "{{graphQueriesTableName}}", + "baseQuery": "{{graphQueriesTableName}}" + } + ], + "sampleQueries": [ + { + "description": "Top 10 Vulerabilities detected", + "query": "{{graphQueriesTableName}}\n | mv-expand todynamic(Detections_s)\n | extend Vulnerability = tostring(Detections_s.Results)\n | summarize count() by Vulnerability\n | top 10 by count_" + } + ], + "dataTypes": [ + { + "name": "{{graphQueriesTableName}}", + "lastDataReceivedQuery": "{{graphQueriesTableName}}\n | summarize Time = max(TimeGenerated)\n | where isnotempty(Time)" + } + ], + "connectivityCriteria": [ + { + "type": "IsConnectedQuery", + "value": [ + "{{graphQueriesTableName}}\n | summarize LastLogReceived = max(TimeGenerated)\n | project IsConnected = LastLogReceived > ago(30d)" + ] + } + ], + "availability": { + "status": 1, + "isPreview": true + }, + "permissions": { + "resourceProvider": [ + { + "provider": "Microsoft.OperationalInsights/workspaces", + "permissionsDisplayText": "read and write permissions on the workspace are required.", + "providerDisplayName": "Workspace", + "scope": "Workspace", + "requiredPermissions": { + "write": true, + "read": true, + "delete": true + } + }, + { + "provider": "Microsoft.OperationalInsights/workspaces/sharedKeys", + "permissionsDisplayText": "read permissions to shared keys for the workspace are required. [See the documentation to learn more about workspace keys](https://docs.microsoft.com/azure/azure-monitor/platform/agent-windows#obtain-workspace-id-and-key).", + "providerDisplayName": "Keys", + "scope": "Workspace", + "requiredPermissions": { + "action": true + } + } + ], + "customs": [ + { + "name": "Microsoft.Web/sites permissions", + "description": "Read and write permissions to Azure Functions to create a Function App is required. [See the documentation to learn more about Azure Functions](https://docs.microsoft.com/azure/azure-functions/)." + }, + { + "name": "Qualys API Key", + "description": "A Qualys VM API username and password is required. [See the documentation to learn more about Qualys VM API](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf)." + } + ] + }, + "instructionSteps": [ + { + "title": "", + "description": ">**NOTE:** This connector uses Azure Functions to connect to Qualys VM to pull its logs into Azure Sentinel. This might result in additional data ingestion costs. Check the [Azure Functions pricing page](https://azure.microsoft.com/pricing/details/functions/) for details." + }, + { + "title": "", + "description": ">**(Optional Step)** Securely store workspace and API authorization key(s) or token(s) in Azure Key Vault. Azure Key Vault provides a secure mechanism to store and retrieve key values. [Follow these instructions](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) to use Azure Key Vault with an Azure Function App." + }, + { + "title": "", + "description": "**STEP 1 - Configuration steps for the Qualys VM API**\n\n1. Log into the Qualys Vulnerability Management console with an administrator account, select the **Users** tab and the **Users** subtab. \n2. Click on the **New** drop-down menu and select **Users..**\n3. Create a username and password for the API account. \n4. In the **User Roles** tab, ensure the account role is set to **Manager** and access is allowed to **GUI** and **API**\n4. Log out of the administrator account and log into the console with the new API credentials for validation, then log out of the API account. \n5. Log back into the console using an administrator account and modify the API accounts User Roles, removing access to **GUI**. \n6. Save all changes." + }, + { + "title": "", + "description": "**STEP 2 - Choose ONE from the following two deployment options to deploy the connector and the associated Azure Function**\n\n>**IMPORTANT:** Before deploying the Qualys VM connector, have the Workspace ID and Workspace Primary Key (can be copied from the following), as well as the Qualys VM API Authorization Key(s), readily available.", + "instructions": [ + { + "parameters": { + "fillWith": [ + "WorkspaceId" + ], + "label": "Workspace ID" + }, + "type": "CopyableLabel" + }, + { + "parameters": { + "fillWith": [ + "PrimaryKey" + ], + "label": "Primary Key" + }, + "type": "CopyableLabel" + } + ] + }, + { + "title": "Option 1 - Azure Resource Manager (ARM) Template", + "description": "Use this method for automated deployment of the Qualys VM connector using an ARM Tempate.\n\n1. Click the **Deploy to Azure** button below. \n\n\t[![Deploy To Azure](https://aka.ms/deploytoazurebutton)](https://aka.ms/sentinelqualysvmazuredeploy)\n2. Select the preferred **Subscription**, **Resource Group** and **Location**. \n3. Enter the **Workspace ID**, **Workspace Key**, **API Username**, **API Password** , update the **URI**, and any additional URI **Filter Parameters** (each filter should be separated by an \"&\" symbol, no spaces.) \n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348) -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format. \n - The default **Time Interval** is set to pull the last five (5) minutes of data. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly (in the function.json file, post deployment) to prevent overlapping data ingestion. \n> - Note: If using Azure Key Vault secrets for any of the values above, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details. \n4. Mark the checkbox labeled **I agree to the terms and conditions stated above**. \n5. Click **Purchase** to deploy." + }, + { + "title": "Option 2 - Manual Deployment of Azure Functions", + "description": "Use the following step-by-step instructions to deploy the Quayls VM connector manually with Azure Functions." + }, + { + "title": "", + "description": "**1. Create a Function App**\n\n1. From the Azure Portal, navigate to [Function App](https://portal.azure.com/#blade/HubsExtension/BrowseResource/resourceType/Microsoft.Web%2Fsites/kind/functionapp), and select **+ Add**.\n2. In the **Basics** tab, ensure Runtime stack is set to **Powershell Core**. \n3. In the **Hosting** tab, ensure the **Consumption (Serverless)** plan type is selected.\n4. Make other preferrable configuration changes, if needed, then click **Create**." + }, + { + "title": "", + "description": "**2. Import Function App Code**\n\n1. In the newly created Function App, select **Functions** on the left pane and click **+ New Function**.\n2. Select **Timer Trigger**.\n3. Enter a unique Function **Name** and leave the default cron schedule of every 5 minutes, then click **Create**.\n5. Click on **Code + Test** on the left pane. \n6. Copy the [Function App Code](https://aka.ms/sentinelqualysvmazurefunctioncode) and paste into the Function App `run.ps1` editor.\n7. Click **Save**." + }, + { + "title": "", + "description": "**3. Configure the Function App**\n\n1. In the Function App, select the Function App Name and select **Configuration**.\n2. In the **Application settings** tab, select **+ New application setting**.\n3. Add each of the following seven (7) application settings individually, with their respective string values (case-sensitive): \n\t\tapiUsername\n\t\tapiPassword\n\t\tworkspaceID\n\t\tworkspaceKey\n\t\turi\n\t\tfilterParameters\n\t\ttimeInterval\n> - Enter the URI that corresponds to your region. The complete list of API Server URLs can be [found here](https://www.qualys.com/docs/qualys-api-vmpc-user-guide.pdf#G4.735348). The `uri` value must follow the following schema: `https:///api/2.0/fo/asset/host/vm/detection/?action=list&vm_processed_after=` -- There is no need to add a time suffix to the URI, the Function App will dynamically append the Time Value to the URI in the proper format.\n> - Add any additional filter parameters, for the `filterParameters` variable, that need to be appended to the URI. Each parameter should be seperated by an \"&\" symbol and should not include any spaces.\n> - Set the `timeInterval` (in minutes) to the value of `5` to correspond to the Timer Trigger of every `5` minutes. If the time interval needs to be modified, it is recommended to change the Function App Timer Trigger accordingly to prevent overlapping data ingestion.\n> - Note: If using Azure Key Vault, use the`@Microsoft.KeyVault(SecretUri={Security Identifier})`schema in place of the string values. Refer to [Key Vault references documentation](https://docs.microsoft.com/azure/app-service/app-service-key-vault-references) for further details.\n4. Once all application settings have been entered, click **Save**." + }, + { + "title": "", + "description": "**4. Configure the host.json**.\n\nDue to the potentially large amount of Qualys host detection data being ingested, it can cause the execution time to surpass the default Function App timeout of five (5) minutes. Increase the default timeout duration to the maximum of ten (10) minutes, under the Consumption Plan, to allow more time for the Function App to execute.\n\n1. In the Function App, select the Function App Name and select the **App Service Editor** blade.\n2. Click **Go** to open the editor, then select the **host.json** file under the **wwwroot** directory.\n3. Add the line `\"functionTimeout\": \"00:10:00\",` above the `managedDependancy` line \n4. Ensure **SAVED** appears on the top right corner of the editor, then exit the editor.\n\n> NOTE: If a longer timeout duration is required, consider upgrading to an [App Service Plan](https://docs.microsoft.com/azure/azure-functions/functions-scale#timeout)" + } + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json new file mode 100644 index 000000000000..726b2d0d4cc8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetGoogleCloudPlatformById.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/GCP_afef3743-0c88-469c-84ff-ca2e87dc1e48", + "name": "GCP_fce27b90-d6f5-4d30-991a-af509a2b50a1", + "type": "Microsoft.SecurityInsights/dataConnectors", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "GCP", + "properties": { + "connectorDefinitionName": "GcpConnector", + "auth": { + "serviceAccountEmail": "sentinel-service-account@project-id.iam.gserviceaccount.com", + "projectNumber": "123456789012", + "workloadIdentityProviderId": "sentinel-identity-provider", + "type": "GCP" + }, + "request": { + "projectId": "project-id", + "subscriptionNames": [ + "sentinel-subscription" + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetIoTById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetIoTById.json new file mode 100644 index 000000000000..bd5a77ac87be --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetIoTById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "d2e5dc7a-f3a2-429d-954b-939fa8c2932e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/d2e5dc7a-f3a2-429d-954b-939fa8c2932e", + "name": "d2e5dc7a-f3a2-429d-954b-939fa8c2932e", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "IOT", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "subscriptionId": "c0688291-89d7-4bed-87a2-a7b1bff43f4c", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json new file mode 100644 index 000000000000..911d7496b226 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftCloudAppSecurityById.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "b96d014d-b5c2-4a01-9aba-a8058f629d42" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/b96d014d-b5c2-4a01-9aba-a8058f629d42", + "name": "b96d014d-b5c2-4a01-9aba-a8058f629d42", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftCloudAppSecurity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + }, + "discoveryLogs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json new file mode 100644 index 000000000000..5dd47ba5892d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftDefenderAdvancedThreatProtectionById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "06b3ccb8-1384-4bcc-aec7-852f6d57161b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "name": "06b3ccb8-1384-4bcc-aec7-852f6d57161b", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftDefenderAdvancedThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json new file mode 100644 index 000000000000..ab7bc1a23a45 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftInsiderRiskManagementById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "3d3e955e-33eb-401d-89a7-251c81ddd660" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficeIRM", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json new file mode 100644 index 000000000000..fb344be54ac2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftPurviewInformationProtectionDataConnetorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftPurviewInformationProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json new file mode 100644 index 000000000000..9dd29d20b4ca --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftThreatIntelligenceById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "microsoftEmergingThreatFeed": { + "state": "Enabled", + "lookbackPeriod": "01/01/1970 00:00:00" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json new file mode 100644 index 000000000000..8d7c279ce6e4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetMicrosoftThreatProtectionById.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "MicrosoftThreatProtection", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "incidents": { + "state": "Enabled" + }, + "alerts": { + "state": "Enabled" + } + }, + "filteredProviders": { + "alerts": [ + "microsoftDefenderForCloudApps" + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json new file mode 100644 index 000000000000..6834d0dd9fec --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOffice365AdvancedThreatProtectionById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "3d3e955e-33eb-401d-89a7-251c81ddd660" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/3d3e955e-33eb-401d-89a7-251c81ddd660", + "name": "3d3e955e-33eb-401d-89a7-251c81ddd660", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficeATP", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "alerts": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json new file mode 100644 index 000000000000..1ce0b29041af --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOffice365ProjectDataConnetorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365Project", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json new file mode 100644 index 000000000000..85683ba57019 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOfficeDataConnetorById.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "Office365", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "sharePoint": { + "state": "Enabled" + }, + "exchange": { + "state": "Enabled" + }, + "teams": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json new file mode 100644 index 000000000000..0cfb5c020eb4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetOfficePowerBIDataConnetorById.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "OfficePowerBI", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "dataTypes": { + "logs": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json new file mode 100644 index 000000000000..c6e1762bec04 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetThreatIntelligenceById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c345bf40-8509-4ed2-b947-50cb773aaf04" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c345bf40-8509-4ed2-b947-50cb773aaf04", + "name": "c345bf40-8509-4ed2-b947-50cb773aaf04", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligence", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "tipLookbackPeriod": "2020-01-01T13:00:30.123Z", + "dataTypes": { + "indicators": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json new file mode 100644 index 000000000000..819e609e9556 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/dataConnectors/GetThreatIntelligenceTaxiiById.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "dataConnectorId": "c39bb458-02a7-4b3f-b0c8-71a1d2692652" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/c39bb458-02a7-4b3f-b0c8-71a1d2692652", + "name": "c39bb458-02a7-4b3f-b0c8-71a1d2692652", + "type": "Microsoft.SecurityInsights/dataConnectors", + "kind": "ThreatIntelligenceTaxii", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "tenantId": "2070ecc9-b4d5-4ae4-adaa-936fa1954fa8", + "workspaceId": "8b014a77-4695-4ef4-96bb-6623afb121a2", + "friendlyName": "My TI Taxii Connector", + "taxiiServer": "https://mytaxiiserver.com/taxiing/v2/api", + "collectionId": "e0b1f32d-1188-48f7-a7a3-de71924e4b5e", + "userName": "", + "password": "", + "taxiiLookbackPeriod": "2020-01-01T13:00:30.123Z", + "pollingFrequency": "OnceADay", + "dataTypes": { + "taxiiClient": { + "state": "Enabled" + } + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/enrichment/GetGeodataByIp.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/enrichment/GetGeodataByIp.json new file mode 100644 index 000000000000..1ca76b4d0181 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/enrichment/GetGeodataByIp.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "ipAddress": "1.2.3.4" + }, + "responses": { + "200": { + "body": { + "asn": "12345", + "carrier": "Microsoft", + "city": "Redmond", + "cityCf": 90, + "continent": "north america", + "country": "united states", + "countryCf": 99, + "ipAddr": "1.2.3.4", + "ipRoutingType": "fixed", + "latitude": "40.2436", + "longitude": "-100.8891", + "organization": "Microsoft", + "organizationType": "tech", + "region": "western usa", + "state": "washington", + "stateCf": null, + "stateCode": "wa" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/enrichment/GetWhoisByDomainName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/enrichment/GetWhoisByDomainName.json new file mode 100644 index 000000000000..879700ee6fbe --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/enrichment/GetWhoisByDomainName.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "domain": "microsoft.com" + }, + "responses": { + "200": { + "body": { + "domain": "microsoft.com", + "server": null, + "created": "2021-09-01T16:15:01.187045Z", + "updated": "2021-09-01T16:15:01.187045Z", + "expires": null, + "parsedWhois": { + "registrar": { + "name": "MarkMonitor, Inc", + "abuseContactPhone": "12083895770", + "abuseContactEmail": "abuse@microsoft.com", + "url": "http://www.markmonitor.com", + "whoisServer": "whois.markmonitor.com" + }, + "contacts": { + "admin": { + "name": "Administrator", + "org": "Microsoft", + "street": [ + "One Microsoft Way" + ], + "city": null, + "state": "WA", + "postal": "98052", + "country": "United States", + "phone": "1-800-555-1234", + "fax": null, + "email": "mail@microsoft.com" + }, + "registrant": null, + "billing": { + "name": "Administrator", + "org": "Microsoft", + "street": [ + "One Microsoft Way" + ], + "city": null, + "state": "WA", + "postal": "98052", + "country": "United States", + "phone": "1-800-555-1234", + "fax": null, + "email": "mail@microsoft.com" + }, + "tech": { + "name": "Administrator", + "org": "Microsoft", + "street": [ + "One Microsoft Way" + ], + "city": null, + "state": "WA", + "postal": "98052", + "country": "United States", + "phone": "1-800-555-1234", + "fax": null, + "email": "mail@microsoft.com" + } + }, + "nameServers": [ + "ns1-205.azure-dns.com", + "ns2-205.azure-dns.net", + "ns3-205.azure-dns.org", + "ns4-205.azure-dns.info" + ], + "statuses": [ + "clientUpdateProhibited", + "clientTransferProhibited", + "clientDeleteProhibited", + "serverUpdateProhibited", + "serverTransferProhibited", + "serverDeleteProhibited" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetAccountEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetAccountEntityById.json new file mode 100644 index 000000000000..08c39b58a043 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetAccountEntityById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Account", + "properties": { + "friendlyName": "administrator", + "accountName": "administrator", + "ntDomain": "domain", + "upnSuffix": "contoso", + "sid": "S-1-5-18", + "aadTenantId": "70fbdad0-7441-4564-b2b5-2b8862d0fee0", + "aadUserId": "f7033626-2572-46b1-bba0-06646f4f95b3", + "puid": "ee3cb2d8-14ba-45ef-8009-d6f1cacfa04d", + "isDomainJoined": true, + "objectGuid": "11227b78-3c6e-436e-a2a2-02fc7662eca0", + "dnsDomain": "contoso.com" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetAzureResourceEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetAzureResourceEntityById.json new file mode 100644 index 000000000000..498d056b26de --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetAzureResourceEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "AzureResource", + "properties": { + "friendlyName": "vm1", + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetCloudApplicationEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetCloudApplicationEntityById.json new file mode 100644 index 000000000000..8016f268f0b5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetCloudApplicationEntityById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "CloudApplication", + "properties": { + "friendlyName": "AppName", + "appId": 1, + "appName": "AppName", + "instanceName": "InstanceName" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetDnsEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetDnsEntityById.json new file mode 100644 index 000000000000..7fc25679727b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetDnsEntityById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "f4e74920-f2c0-4412-a45f-66d94fdf01f8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/f4e74920-f2c0-4412-a45f-66d94fdf01f8", + "name": "f4e74920-f2c0-4412-a45f-66d94fdf01f8", + "type": "Microsoft.SecurityInsights/entities", + "kind": "DnsResolution", + "properties": { + "friendlyName": "domain", + "domainName": "domain", + "ipAddressEntityIds": [ + "475d3120-33e0-4841-9f1c-a8f15a801d19" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetEntities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetEntities.json new file mode 100644 index 000000000000..cbe8c901365c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetEntities.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Account", + "properties": { + "friendlyName": "administrator", + "accountName": "administrator", + "ntDomain": "domain", + "upnSuffix": "contoso", + "sid": "S-1-5-18", + "aadTenantId": "70fbdad0-7441-4564-b2b5-2b8862d0fee0", + "aadUserId": "f7033626-2572-46b1-bba0-06646f4f95b3", + "puid": "ee3cb2d8-14ba-45ef-8009-d6f1cacfa04d", + "isDomainJoined": true, + "objectGuid": "11227b78-3c6e-436e-a2a2-02fc7662eca0" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/fed9fe89-dce8-40f2-bf44-70f23fe93b3c", + "name": "fed9fe89-dce8-40f2-bf44-70f23fe93b3c", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Host", + "properties": { + "friendlyName": "vm1", + "dnsDomain": "contoso", + "ntDomain": "domain", + "hostName": "vm1", + "netBiosName": "contoso", + "azureID": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "omsAgentID": "70fbdad0-7441-4564-b2b5-2b8862d0fee0", + "osFamily": "Windows", + "osVersion": "1.0", + "isDomainJoined": true + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/af378b21-b4aa-4fe7-bc70-13f8621a322f", + "name": "af378b21-b4aa-4fe7-bc70-13f8621a322f", + "type": "Microsoft.SecurityInsights/entities", + "kind": "File", + "properties": { + "friendlyName": "cmd.exe", + "directory": "C:\\Windows\\System32", + "fileName": "cmd.exe" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetFileEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetFileEntityById.json new file mode 100644 index 000000000000..a0edd4a8e1f9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetFileEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "af378b21-b4aa-4fe7-bc70-13f8621a322f" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/af378b21-b4aa-4fe7-bc70-13f8621a322f", + "name": "af378b21-b4aa-4fe7-bc70-13f8621a322f", + "type": "Microsoft.SecurityInsights/entities", + "kind": "File", + "properties": { + "friendlyName": "cmd.exe", + "directory": "C:\\Windows\\System32", + "fileName": "cmd.exe" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetFileHashEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetFileHashEntityById.json new file mode 100644 index 000000000000..9e9edc8a1dec --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetFileHashEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "ea359fa6-c1e5-f878-e105-6344f3e399a1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/ea359fa6-c1e5-f878-e105-6344f3e399a1", + "name": "ea359fa6-c1e5-f878-e105-6344f3e399a1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "FileHash", + "properties": { + "friendlyName": "E923636F1093C414AAB39F846E9D7A372BEEFA7B628B28179197E539C56AA0F0(SHA256)", + "hashValue": "E923636F1093C414AAB39F846E9D7A372BEEFA7B628B28179197E539C56AA0F0", + "algorithm": "SHA256" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetHostEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetHostEntityById.json new file mode 100644 index 000000000000..4cefa6c25563 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetHostEntityById.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Host", + "properties": { + "friendlyName": "vm1", + "dnsDomain": "contoso", + "ntDomain": "domain", + "hostName": "vm1", + "netBiosName": "contoso", + "azureID": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "omsAgentID": "70fbdad0-7441-4564-b2b5-2b8862d0fee0", + "osFamily": "Windows", + "osVersion": "1.0", + "isDomainJoined": true + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetIoTDeviceEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetIoTDeviceEntityById.json new file mode 100644 index 000000000000..ba69e56d732f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetIoTDeviceEntityById.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "IoTDevice", + "properties": { + "friendlyName": "device1", + "deviceId": "device1", + "deviceName": "device1", + "iotHubEntityId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/8b2d9401-f953-e89d-2583-be9b4975870c", + "nicEntityIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/6ee379bd-ace8-44cf-ab10-ee669a1b71e2" + ], + "deviceType": "Industrial", + "firmwareVersion": "20.11", + "importance": "Normal", + "isAuthorized": true, + "isProgramming": false, + "isScanner": false, + "model": "demo-model", + "protocols": [ + "CIP", + "EtherNet/IP" + ], + "operatingSystem": "Windows", + "purdueLayer": "ProcessControl", + "sensor": "demo-sensor", + "site": "demo-site", + "vendor": "demo-vendor", + "zone": "zone" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetIpEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetIpEntityById.json new file mode 100644 index 000000000000..db9190923cd0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetIpEntityById.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Ip", + "properties": { + "friendlyName": "10.3.2.8", + "address": "10.3.2.8" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailClusterEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailClusterEntityById.json new file mode 100644 index 000000000000..17d264a012f5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailClusterEntityById.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "MailCluster", + "properties": { + "friendlyName": "ClusterSourceIdentifier", + "networkMessageIds": [ + "ccfce855-e02f-491b-a1cc-5bafb371ad0c" + ], + "countByDeliveryStatus": { + "deliveryStatus": 5 + }, + "countByThreatType": { + "threatType": 6 + }, + "countByProtectionStatus": { + "protectionStatus": 65 + }, + "threats": [ + "thrreat1", + "thread2" + ], + "query": "kqlFilter", + "queryTime": "2021-09-01T01:42:01.6026755Z", + "source": "ClusterSourceIdentifier", + "clusterSourceIdentifier": "cluster source identifier", + "clusterSourceType": "Similarity", + "clusterGroup": "cluster group" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailMessageEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailMessageEntityById.json new file mode 100644 index 000000000000..ee9c2bd6412f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailMessageEntityById.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "MailMessage", + "properties": { + "friendlyName": "cmd.exe", + "fileEntityIds": [ + "ccfce855-e02f-491b-a1cc-5bafb371ad0c" + ], + "recipient": "recipient", + "urls": [ + "http://moqbrarcwmnk.banxhdcojlg.biz" + ], + "threats": [ + "thrreat1", + "thread2" + ], + "p1Sender": "email@fake.com", + "p1SenderDisplayName": "p1 sender display name", + "p1SenderDomain": "p1 sender domain", + "senderIP": "1.23.34.43", + "p2Sender": "the sender", + "deliveryAction": "Blocked", + "p2SenderDisplayName": "p2 sender display name", + "p2SenderDomain": "p2 Sender Domain", + "internetMessageId": "message id", + "subject": "subject", + "language": "language", + "threatDetectionMethods": [ + "thrreat1", + "thread2" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailboxEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailboxEntityById.json new file mode 100644 index 000000000000..ac9d2eb4205c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMailboxEntityById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Mailbox", + "properties": { + "friendlyName": "emailAddress1", + "displayName": "display name", + "mailboxPrimaryAddress": "emailAddress1", + "upn": "upn1", + "externalDirectoryObjectId": "18cc8fdc-e169-4451-983a-bd027db286eb" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMalwareEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMalwareEntityById.json new file mode 100644 index 000000000000..0f94ac9f68f5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetMalwareEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "af378b21-b4aa-4fe7-bc70-13f8621a322f" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/af378b21-b4aa-4fe7-bc70-13f8621a322f", + "name": "af378b21-b4aa-4fe7-bc70-13f8621a322f", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Malware", + "properties": { + "malwareName": "Win32/Toga!rfn", + "category": "Trojan", + "friendlyName": "Win32/Toga!rfn" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetProcessEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetProcessEntityById.json new file mode 100644 index 000000000000..2f8fc2b7f6ec --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetProcessEntityById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "7264685c-038c-42c6-948c-38e14ef1fb98" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/7264685c-038c-42c6-948c-38e14ef1fb98", + "name": "7264685c-038c-42c6-948c-38e14ef1fb98", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Process", + "properties": { + "friendlyName": "cmd.exe", + "processId": "0x2aa48", + "commandLine": "\"cmd\"", + "imageFileEntityId": "bba7b47b-c1c1-4021-b568-5b07b9292f5e" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetQueries.json new file mode 100644 index 000000000000..c6cd7a1fd86f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetQueries.json @@ -0,0 +1,456 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "kind": "Insight" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1/queries/6db7f5d1-f41e-46c2-b935-230b36a569e6", + "name": "6db7f5d1-f41e-46c2-b935-230b36a569e6", + "type": "Microsoft.SecurityInsights/entities/queries", + "kind": "Insight", + "properties": { + "displayName": "Actions on account", + "description": "Summary of actions taken on the specified account, grouped by action: password resets and changes, account lockouts (policy or admin), account creation and deletion, account enabled and disabled\n", + "baseQuery": "let GetAccountActions = (v_Account_Name:string, v_Account_NTDomain:string, v_Account_UPNSuffix:string, v_Account_AADUserId:string, v_Account_SID:string){\nAuditLogs\n| where OperationName in~ ('Delete user', 'Change user password', 'Reset user password', 'Change password (self-service)', 'Reset password (by admin)', 'Reset password (self-service)', 'Update user')\n| extend UserPrincipalName = tostring(TargetResources[0].userPrincipalName)\n| extend Account_Name = tostring(split(UserPrincipalName, '@')[0])\n| extend Account_UPNSuffix = tostring(split(UserPrincipalName, '@')[1])\n| extend Action = tostring(parse_json(tostring(parse_json(tostring(TargetResources[0].modifiedProperties))[0])))\n| extend ModifiedProperty = parse_json(Action).displayName\n| extend ModifiedValue = parse_json(Action).newValue\n| extend Account_AADUserId = tostring(TargetResources[0].id)\n| extend DisableUser = iif(ModifiedProperty =~ 'AccountEnabled' and ModifiedValue =~ '[false]', 'True', 'False')\n| union isfuzzy=true (\nSecurityEvent\n| where EventID in (4720, 4722, 4723, 4724, 4725, 4726, 4740)\n| extend OperationName = tostring(EventID)\n| where AccountType =~ \"user\" or isempty(AccountType)\n| extend Account_Name = TargetUserName, Account_NTDomain = TargetDomainName, Account_SID = TargetSid\n)\n| where (Account_Name =~ v_Account_Name and (Account_UPNSuffix =~ v_Account_UPNSuffix or Account_NTDomain =~ v_Account_NTDomain)) or Account_AADUserId =~ v_Account_AADUserId or Account_SID =~ v_Account_SID\n};\nGetAccountActions('CTFFUser4', '', 'seccxp.ninja', '', '')\n", + "tableQuery": { + "columnsDefinitions": [ + { + "header": "Action", + "outputType": "String", + "supportDeepLink": false + }, + { + "header": "Most Recent", + "outputType": "Date", + "supportDeepLink": false + }, + { + "header": "Count", + "outputType": "Number", + "supportDeepLink": true + } + ], + "queriesDefinitions": [ + { + "filter": "where OperationName in~ ('Change user password', 'Reset user password', 'Change password (self-service)', 'Reset password (by admin)', 'Reset password (self-service)', '4724', '4723')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('Blocked from self-service password reset', '4740')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName == '4725' or (OperationName =~ 'Update user' and DisableUser =~ 'True')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('Add user', '4720')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('Delete user', '4726')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('4725', 'Blocked from self-service password reset', '4740') or (OperationName =~ 'Update user' and DisableUser =~ 'True')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('4722', '4767') or (OperationName =~ 'Update user' and DisableUser =~ 'False')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where OperationName in~ ('Update user','4738')", + "summarize": "summarize MostRecent = max(TimeGenerated), Count = count() by OperationName", + "project": "project Title = OperationName, MostRecent, Count", + "linkColumnsDefinitions": [ + { + "projectedName": "Count", + "Query": "{{BaseQuery}} | " + } + ] + } + ] + }, + "chartQuery": { + "title": "Actions by type", + "dataSets": [ + { + "query": "summarize Count = count() by bin(TimeGenerated, 1h), OperationName", + "xColumnName": "TimeGenerated", + "yColumnName": "Count", + "legendColumnName": "OperationName" + } + ], + "type": "BarChart" + }, + "additionalQuery": { + "text": "See all account activity", + "query": "project TimeGenerated, UserPrincipalName, Account_Name, OperationName, Activity, DisableUser, TargetSid, AADUserId, InitiatedBy, AADTenantId, AccountType, Computer, SubjectAccount, SubjectUserSid, EventData" + }, + "defaultTimeRange": { + "beforeRange": "12h", + "afterRange": "12h" + }, + "referenceTimeRange": null, + "dataTypes": [ + { + "dataType": "AuditLogs" + }, + { + "dataType": "SecurityEvent" + } + ], + "inputEntityType": "Account", + "requiredInputFieldsSets": [ + [ + "Account_Name", + "Account_NTDomain" + ], + [ + "Account_Name", + "Account_UPNSuffix" + ], + [ + "Account_AADUserId" + ], + [ + "Account_SID" + ] + ], + "entitiesFilter": {} + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1/queries/0a5d7b14-b485-450a-a0ac-4100c860ac32", + "name": "0a5d7b14-b485-450a-a0ac-4100c860ac32", + "type": "Microsoft.SecurityInsights/entities/queries", + "kind": "Insight", + "properties": { + "displayName": "Anomalously high office operation count", + "description": "Highlight office operations of the user with anomalously high count compared to those observed in the preceding 14 days.", + "baseQuery": "let AScoreThresh = 3; \nlet maxAnomalies = 3;\nlet BeforeRange = 12d; \nlet EndTime = todatetime('{{EndTimeUTC}}'); \nlet StartTime = todatetime('{{StartTimeUTC}}');\nlet numDays = tolong((EndTime-StartTime)/1d); \nlet userData = (v_Account_Name:string, v_Account_UPNSuffix:string) { \n OfficeActivity \n | extend splitUserId=split(UserId, '@')\n | extend Account_Name = tostring(splitUserId[0]), Account_UPNSuffix = tostring(splitUserId[1])\n | where Account_Name =~ v_Account_Name and Account_UPNSuffix =~ v_Account_UPNSuffix }; \nuserData('CTFFUser4', 'seccxp.ninja')\n", + "tableQuery": { + "columnsDefinitions": [ + { + "header": "Operation", + "outputType": "String", + "supportDeepLink": true + }, + { + "header": "Expected Count", + "outputType": "Number", + "supportDeepLink": false + }, + { + "header": "Actual Count", + "outputType": "Number", + "supportDeepLink": false + } + ], + "queriesDefinitions": [ + { + "filter": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by Operation \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost=maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_ \n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore-maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies \n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,postExpectedCount) \n| where maxAnomalyScorePost > AScoreThresh \n| order by maxAnomalyScorePost desc\n", + "summarize": "take 1", + "project": "project Operation, expectedCount=round(postExpectedCount,2), actualCount=postActualCount, anomalyScore=round(postAnomalyScore,2)", + "linkColumnsDefinitions": [ + { + "projectedName": "Operation", + "Query": "{{BaseQuery}} \n| where TimeGenerated between (StartTime .. EndTime) \n| where Operation == ''\n" + } + ] + } + ] + }, + "chartQuery": { + "title": "Anomalous operation timeline", + "dataSets": [ + { + "query": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by Operation \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost=maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_ \n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore-maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies \n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,round(postExpectedCount,2)) \n| where maxAnomalyScorePost > AScoreThresh \n| order by maxAnomalyScorePost desc \n| take 1 \n| project Operation, TimeGenerated, count_\n| mvexpand TimeGenerated, count_ | project todatetime(TimeGenerated), toint(count_), Operation\n", + "xColumnName": "TimeGenerated", + "yColumnName": "count_", + "legendColumnName": "Operation" + } + ], + "type": "LineChart" + }, + "additionalQuery": { + "text": "Query all anomalous operations", + "query": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by Operation \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost = maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_\n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore - maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies\n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,postExpectedCount) \n| where maxAnomalyScorePost > AScoreThresh | order by maxAnomalyScorePost desc \n| project Operation, expectedCount=round(postExpectedCount,2), actualCount=postActualCount, anomalyScore=round(postAnomalyScore,2)\n" + }, + "defaultTimeRange": { + "beforeRange": "1d", + "afterRange": "0d" + }, + "referenceTimeRange": { + "beforeRange": "12d" + }, + "dataTypes": [ + { + "dataType": "OfficeActivity" + } + ], + "inputEntityType": "Account", + "requiredInputFieldsSets": [ + [ + "Account_Name", + "Account_UPNSuffix" + ] + ], + "entitiesFilter": {} + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1/queries/e6cf68e6-1eca-4fbb-9fad-6280f2a9476e", + "name": "e6cf68e6-1eca-4fbb-9fad-6280f2a9476e", + "type": "Microsoft.SecurityInsights/entities/queries", + "kind": "Insight", + "properties": { + "displayName": "Resource access", + "description": "Provides the count and distinct resource accesses by a given user account\n", + "baseQuery": "let Operations = dynamic([\"FileDownloaded\", \"FileUploaded\"]);\nlet UserOperationToSharePoint = (v_Account_Name:string, v_Account_UPNSuffix:string) {\nOfficeActivity\n// Select sharepoint activity that is relevant\n| where RecordType in~ ('SharePointFileOperation')\n| where Operation in~ (Operations)\n| extend Account_Name = tostring(split(UserId, '@')[0])\n| extend Account_UPNSuffix = tostring(split(UserId, '@')[1])\n| where Account_Name =~ v_Account_Name and Account_UPNSuffix =~ v_Account_UPNSuffix\n| project TimeGenerated, Account_Name, Account_UPNSuffix, UserId, OfficeId, RecordType, Operation, OrganizationId, UserType, UserKey, OfficeWorkload, OfficeObjectId, ClientIP, ItemType, UserAgent, Site_Url, SourceRelativeUrl, SourceFileName, SourceFileExtension , Start_Time , ElevationTime , TenantId, SourceSystem , Type\n};\nUserOperationToSharePoint ('CTFFUser4','seccxp.ninja')\n", + "tableQuery": { + "columnsDefinitions": [ + { + "header": "Resource Type", + "outputType": "String", + "supportDeepLink": false + }, + { + "header": "Distinct Resources", + "outputType": "Number", + "supportDeepLink": true + }, + { + "header": "Total Resources", + "outputType": "Number", + "supportDeepLink": true + }, + { + "header": "IPAddress(es)", + "outputType": "String", + "supportDeepLink": false + } + ], + "queriesDefinitions": [ + { + "filter": "where Operation =~ 'FileUploaded'", + "summarize": "summarize DistinctResources = dcount(SourceFileName), TotalResources = count(SourceFileName), IPAddresses = make_set(ClientIP) by Operation", + "project": "project Title = Operation, DistinctResources, TotalResources, IPAddresses = case(array_length(IPAddresses) == 1, tostring(IPAddresses[0]), array_length(IPAddresses) > 1, 'Many', 'None')", + "linkColumnsDefinitions": [ + { + "projectedName": "DistinctResources", + "Query": "{{BaseQuery}} | " + }, + { + "projectedName": "TotalResources", + "Query": "{{BaseQuery}} | " + } + ] + }, + { + "filter": "where Operation =~ 'FileDownloaded'", + "summarize": "summarize DistinctResources = dcount(SourceFileName), TotalResources = count(SourceFileName), IPAddresses = make_set(ClientIP) by Operation", + "project": "project Title = Operation, DistinctResources, TotalResources, IPAddresses = case(array_length(IPAddresses) == 1, tostring(IPAddresses[0]), array_length(IPAddresses) > 1, 'Many', 'None')", + "linkColumnsDefinitions": [ + { + "projectedName": "DistinctResources", + "Query": "{{BaseQuery}} | " + }, + { + "projectedName": "TotalResources", + "Query": "{{BaseQuery}} | " + } + ] + } + ] + }, + "chartQuery": { + "title": "Resource access over time", + "dataSets": [ + { + "query": "summarize DistinctResources = dcountif(Operation, Operation =~ 'FileUploaded'), TotalResources = countif(Operation =~ 'FileUploaded') by bin(TimeGenerated, 1h) | extend Legend = 'File Uploads'", + "xColumnName": "TimeGenerated", + "yColumnName": "TotalResources", + "legendColumnName": "Legend" + }, + { + "query": "summarize DistinctResources = dcountif(Operation, Operation =~ 'FileDownloaded'), TotalResources = countif(Operation =~ 'FileDownloaded') by bin(TimeGenerated, 1h) | extend Legend = 'File Downloads'", + "xColumnName": "TimeGenerated", + "yColumnName": "TotalResources", + "legendColumnName": "Legend" + } + ], + "type": "LineChart" + }, + "additionalQuery": { + "text": "See all resource activity", + "query": "where Operation in~ (Operations)" + }, + "defaultTimeRange": { + "beforeRange": "12h", + "afterRange": "12h" + }, + "referenceTimeRange": null, + "dataTypes": [ + { + "dataType": "OfficeActivity" + } + ], + "inputEntityType": "Account", + "requiredInputFieldsSets": [ + [ + "Account_Name", + "Account_UPNSuffix" + ], + [ + "Account_AADUserId" + ] + ], + "entitiesFilter": {} + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1/queries/cae8d0aa-aa45-4d53-8d88-17dd64ffd4e4", + "name": "cae8d0aa-aa45-4d53-8d88-17dd64ffd4e4", + "type": "Microsoft.SecurityInsights/entities/queries", + "kind": "Insight", + "properties": { + "displayName": "Anomalously high Azure sign-in result count", + "description": "Highlight Azure sign-in results by the user principal with anomalously high count compared to those observed in the preceding 14 days.", + "baseQuery": "let AScoreThresh=3; \nlet maxAnomalies=3; \nlet BeforeRange = 12d; \nlet EndTime=todatetime('{{EndTimeUTC}}');\nlet StartTime = todatetime('{{StartTimeUTC}}'); \nlet numDays = tolong((EndTime-StartTime)/1d); \nlet userData = (v_Account_Name:string, v_Account_UPNSuffix:string, v_Account_AADUserId:string) { \n SigninLogs \n | where TimeGenerated between ((StartTime-BeforeRange) .. EndTime)\n | extend splitUserId=split(UserPrincipalName, '@')\n | extend Account_Name = tostring(splitUserId[0]), Account_UPNSuffix = tostring(splitUserId[1])\n | where (Account_Name =~ v_Account_Name and Account_UPNSuffix =~ v_Account_UPNSuffix) or UserId =~ v_Account_AADUserId };\nuserData('CTFFUser4', 'seccxp.ninja', '')\n", + "tableQuery": { + "columnsDefinitions": [ + { + "header": "Result Description", + "outputType": "String", + "supportDeepLink": true + }, + { + "header": "Expected Count", + "outputType": "Number", + "supportDeepLink": false + }, + { + "header": "Actual Count", + "outputType": "Number", + "supportDeepLink": false + } + ], + "queriesDefinitions": [ + { + "filter": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by ResultDescription \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost = maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_ \n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore - maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies \n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,postExpectedCount) \n| where maxAnomalyScorePost > AScoreThresh \n| order by maxAnomalyScorePost desc\n", + "summarize": "take 1", + "project": "project ResultDescription, expectedCount=round(postExpectedCount,2), actualCount=postActualCount, anomalyScore=round(postAnomalyScore,2)", + "linkColumnsDefinitions": [ + { + "projectedName": "ResultDescription", + "Query": "{{BaseQuery}} \n| where TimeGenerated between (StartTime .. EndTime) \n| where ResultDescription == ''\n" + } + ] + } + ] + }, + "chartQuery": { + "title": "Anomalous sign-in result timeline", + "dataSets": [ + { + "query": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by ResultDescription \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost = maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_ \n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore - maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies \n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,round(postExpectedCount,2)) \n| where maxAnomalyScorePost > AScoreThresh \n| order by maxAnomalyScorePost desc \n| take 1 \n| project ResultDescription, TimeGenerated, count_ \n| mvexpand TimeGenerated, count_ \n| project todatetime(TimeGenerated), toint(count_), ResultDescription \n", + "xColumnName": "TimeGenerated", + "yColumnName": "count_", + "legendColumnName": "ResultDescription" + } + ], + "type": "LineChart" + }, + "additionalQuery": { + "text": "Query all anomalous sign-in results", + "query": "make-series count() default=0 on TimeGenerated from (StartTime - BeforeRange) to EndTime step 1d by ResultDescription \n| extend (anomalies,anomalyScore, expectedCount)=series_decompose_anomalies(count_,AScoreThresh,7,'linefit',numDays, 'ctukey') \n| extend count1=count_, TimeGenerated1=TimeGenerated, anomalyScore1=anomalyScore\n| mv-apply count1 to typeof(long), TimeGenerated1 to typeof(datetime), anomalyScore1 to typeof(double), anomalies to typeof(long) on (summarize totAnomalies=sumif(abs(anomalies), TimeGenerated1 < StartTime), baseStd=stdevif(count1, TimeGenerated1 < StartTime), baseAvg=avgif(count1, TimeGenerated1 < StartTime), maxCountPost=maxif(count1,TimeGenerated1 >= StartTime), maxAnomalyScorePost = maxif(anomalyScore1, TimeGenerated1 >= StartTime)) \n| extend count1=count_\n| mv-apply count1 to typeof(long), anomalyScore to typeof(double), expectedCount to typeof(double) on ( summarize (dummy, postExpectedCount, postActualCount)=arg_min(abs(anomalyScore - maxAnomalyScorePost), expectedCount, count1) ) \n| where totAnomalies < maxAnomalies\n| extend postAnomalyScore=iff(baseStd == 0 and maxCountPost > tolong(count_[0]),1000.0,maxAnomalyScorePost), postExpectedCount=iff(postExpectedCount < 0,0.0,postExpectedCount) \n| where maxAnomalyScorePost > AScoreThresh \n| order by maxAnomalyScorePost desc \n| project ResultDescription, expectedCount=round(postExpectedCount,2), actualCount=postActualCount, anomalyScore=round(postAnomalyScore,2)\n" + }, + "defaultTimeRange": { + "beforeRange": "1d", + "afterRange": "0d" + }, + "referenceTimeRange": { + "beforeRange": "12d" + }, + "dataTypes": [ + { + "dataType": "SigninLogs" + } + ], + "inputEntityType": "Account", + "requiredInputFieldsSets": [ + [ + "Account_Name", + "Account_UPNSuffix" + ], + [ + "Account_AADUserId" + ] + ], + "entitiesFilter": {} + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetRegistryKeyEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetRegistryKeyEntityById.json new file mode 100644 index 000000000000..8ead0eca0e36 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetRegistryKeyEntityById.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "RegistryKey", + "properties": { + "friendlyName": "SOFTWARE", + "hive": "HKEY_LOCAL_MACHINE", + "key": "SOFTWARE" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetRegistryValueEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetRegistryValueEntityById.json new file mode 100644 index 000000000000..d428b2449c06 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetRegistryValueEntityById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "dc44bd11-b348-4d76-ad29-37bf7aa41356" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/dc44bd11-b348-4d76-ad29-37bf7aa41356", + "name": "dc44bd11-b348-4d76-ad29-37bf7aa41356", + "type": "Microsoft.SecurityInsights/entities", + "kind": "RegistryValue", + "properties": { + "friendlyName": "Data", + "valueName": "Name", + "valueData": "Data", + "valueType": "String", + "keyEntityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSecurityAlertEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSecurityAlertEntityById.json new file mode 100644 index 000000000000..199b0e7c0166 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSecurityAlertEntityById.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "4aa486e0-6f85-41af-99ea-7acdce7be6c8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/4aa486e0-6f85-41af-99ea-7acdce7be6c8", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "SecurityAlert", + "properties": { + "systemAlertId": "4aa486e0-6f85-41af-99ea-7acdce7be6c8", + "intent": "Unknown", + "alertDisplayName": "Suspicious account detected", + "description": "", + "confidenceLevel": "Unknown", + "severity": "Medium", + "vendorName": "Microsoft", + "productName": "Azure Sentinel", + "productComponentName": "Scheduled Alerts", + "alertType": "c8c99641-985d-4e4e-8e91-fb3466cd0e5b_46c7b6c0-ff43-44dd-8b4d-ceffff7aa7df", + "providerAlertId": "c2bafff9-fb31-41d0-a177-ecbff7a02ffe", + "processingEndTime": "2019-07-06T13:56:53.5392366Z", + "status": "New", + "endTimeUtc": "2021-09-01T13:21:45.926185Z", + "startTimeUtc": "2021-09-01T08:21:45.926185Z", + "timeGenerated": "2021-09-01T13:56:53.5392366Z", + "tactics": [ + "Persistence", + "LateralMovement" + ], + "additionalData": { + "Query": "Heartbeat \n| extend AccountCustomEntity = \"administrator\"", + "Query Period": "05:00:00", + "Trigger Operator": "GreaterThan", + "Trigger Threshold": "200", + "Search Query Results Overall Count": "203", + "Total Account Entities": "1" + }, + "friendlyName": "Suspicious account detected", + "alertLink": "https://portal.azure.com/#blade/Microsoft_Azure_Security/AlertBlade/alertId/2518119885989999999_4aa486e0-6f85-41af-99ea-7acdce7be6c8/subscriptionId/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/myRg/myWorkspace/referencedFrom/alertDeepLink/location/centralus" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSecurityGroupEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSecurityGroupEntityById.json new file mode 100644 index 000000000000..08f7af3df035 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSecurityGroupEntityById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "SecurityGroup", + "properties": { + "friendlyName": "Name", + "distinguishedName": "Name", + "sid": "Sid", + "objectGuid": "fb1b8e04-d944-4986-b39a-1ce9adedcd98" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSubmissionMailEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSubmissionMailEntityById.json new file mode 100644 index 000000000000..e48fce051724 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetSubmissionMailEntityById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "SubmissionMail", + "properties": { + "friendlyName": "recipient", + "submissionId": "5bb3d8fe-54bc-499c-bc21-86fe8df2a184", + "submitter": "submitter", + "recipient": "recipient", + "sender": "sender", + "senderIp": "1.4.35.34", + "subject": "subject", + "reportType": "report type" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetUrlEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetUrlEntityById.json new file mode 100644 index 000000000000..73b1d672eb2a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/GetUrlEntityById.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Url", + "properties": { + "friendlyName": "https://bing.com", + "url": "https://bing.com" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/expand/PostExpandEntity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/expand/PostExpandEntity.json new file mode 100644 index 000000000000..5d77aa1819a3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/expand/PostExpandEntity.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "parameters": { + "expansionId": "a77992f3-25e9-4d01-99a4-5ff606cc410a", + "startTime": "2019-04-25T00:00:00.000Z", + "endTime": "2019-05-26T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "value": { + "entities": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/entities", + "kind": "Ip", + "properties": { + "address": "13.89.108.248", + "friendlyName": "13.89.108.248" + } + } + ], + "edges": [ + { + "targetEntityId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/c1d60d86-5988-11eb-ae93-0242ac130002", + "additionalData": { + "EpochTimestamp": "1608289949", + "FirstSeen": "2021-09-01T11:12:29.597Z", + "Source": "Heartbeat" + } + } + ] + }, + "metaData": { + "aggregations": [ + { + "entityKind": "Account", + "count": 1 + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/insights/PostGetInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/insights/PostGetInsights.json new file mode 100644 index 000000000000..0ba5b1f76175 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/insights/PostGetInsights.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "parameters": { + "addDefaultExtendedTimeRange": false, + "startTime": "2021-09-01T00:00:00.000Z", + "endTime": "2021-10-01T00:00:00.000Z", + "insightQueryIds": [ + "cae8d0aa-aa45-4d53-8d88-17dd64ffd4e4" + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "tableQueryResults": { + "columns": [ + { + "name": "Title", + "type": "string" + }, + { + "name": "NameCount", + "type": "long" + }, + { + "name": "SIDCount", + "type": "long" + }, + { + "name": "InternalOrder", + "type": "long" + }, + { + "name": "Index", + "type": "long" + } + ], + "rows": [ + [ + "MyTitle", + "15", + "SID", + "1", + "1" + ] + ] + }, + "chartQueryResults": [ + { + "columns": [ + { + "name": "TimeGenerated", + "type": "datetime" + }, + { + "name": "Count", + "type": "long" + }, + { + "name": "Legend", + "type": "string" + } + ], + "rows": [ + [ + "2021-09-01T00:00:00.000Z", + "55", + "SomeLegend" + ] + ] + } + ], + "queryTimeInterval": { + "startTime": "2021-09-01T23:35:20Z", + "endTime": "2021-09-01T23:35:20Z" + }, + "queryId": "e29ee1ef-7445-455e-85f1-269f2d536d61" + } + ], + "metaData": { + "totalCount": 7, + "errors": [ + { + "kind": "Insight", + "queryId": "4a70a63d-25c4-6312-b73e-4f302a90c06a", + "errorMessage": "Internal server error" + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/relations/GetAllEntityRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/relations/GetAllEntityRelations.json new file mode 100644 index 000000000000..47eb12347212 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/relations/GetAllEntityRelations.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/entities/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/relations/GetEntityRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/relations/GetEntityRelationByName.json new file mode 100644 index 000000000000..987b62390955 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/relations/GetEntityRelationByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/entities/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/incidents" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/timeline/PostTimelineEntity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/timeline/PostTimelineEntity.json new file mode 100644 index 000000000000..3009d903d843 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entities/timeline/PostTimelineEntity.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityId": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "parameters": { + "numberOfBucket": 4, + "startTime": "2021-09-01T00:00:00.000Z", + "endTime": "2021-10-01T00:00:00.000Z" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "kind": "SecurityAlert", + "description": "The alert description", + "azureResourceId": "4467341f-fb73-4f99-a9b3-29473532cf5a_bf7c3a2f-b743-6410-3ff0-ec64b5995d50", + "productName": "Azure Sentinel", + "displayName": "Alert display name", + "severity": "Medium", + "endTimeUtc": "2021-09-01T23:31:28.02Z", + "startTimeUtc": "2021-09-01T23:32:28.01Z", + "timeGenerated": "2021-09-01T23:37:25.8136594Z", + "alertType": "4467341f-fb73-4f99-a9b3-29473532cf5a_c93bf33e-055e-4972-9e7d-f84fe3fb61ae", + "Intent": "Discovery" + }, + { + "kind": "Activity", + "queryId": "e0459780-ac9d-4b72-8bd4-fecf6b46a0a1", + "bucketStartTimeUTC": "2021-09-01T21:31:28.02Z", + "bucketEndTimeUTC": "2021-09-01T23:31:28.02Z", + "firstActivityTimeUTC": "2021-09-01T21:35:28.02Z", + "lastActivityTimeUTC": "2021-09-01T21:35:28.02Z", + "content": "he user has deleted the account 3 time(s)", + "title": "The user has deleted an account" + }, + { + "kind": "Anomaly", + "azureResourceId": "4467341f-fb73-4f99-a9b3-29473532cf5a_d56430ef-f421-2c9c-0b7d-d082285843c6", + "description": "Anomalous private to public port scanning activity with high destination port count along with low port ratio. The ratios are normalized by multiplying them by 10,000 to get them to a more usable value between 0.0 and 1.0.", + "productName": "Azure Sentinel", + "displayName": "(Preview) Anomalous scanning activity", + "endTimeUtc": "2021-09-01T23:31:28.02Z", + "startTimeUtc": "2021-09-01T23:32:28.01Z", + "timeGenerated": "2021-09-01T23:37:25.8136594Z", + "vendor": "Microsoft", + "intent": "Discovery", + "techniques": [ + "T1046" + ], + "reasons": [ + "High destination port count", + "Low port ratio" + ] + } + ], + "metaData": { + "totalCount": 6, + "aggregations": [ + { + "count": 4, + "kind": "Activity" + }, + { + "count": 2, + "kind": "SecurityAlert" + }, + { + "count": 1, + "kind": "Anomaly" + } + ], + "errors": [ + { + "kind": "Activity", + "queryId": "11067f9f-d6a7-4488-887f-0ba564268879", + "errorMessage": "syntax error" + }, + { + "kind": "SecurityAlert", + "errorMessage": "internal server error" + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/CreateEntityQueryActivity.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/CreateEntityQueryActivity.json new file mode 100644 index 000000000000..4910740c8e4c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/CreateEntityQueryActivity.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "entityQuery": { + "kind": "Activity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "kind": "Activity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null, + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "kind": "Activity", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null, + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/DeleteEntityQuery.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/DeleteEntityQuery.json new file mode 100644 index 000000000000..c27e0635f582 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/DeleteEntityQuery.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetActivityEntityQueryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetActivityEntityQueryById.json new file mode 100644 index 000000000000..6d8a4c2c2942 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetActivityEntityQueryById.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Activity", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "enabled": true, + "templateName": null, + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetEntityQueries.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetEntityQueries.json new file mode 100644 index 000000000000..ad16315341e6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetEntityQueries.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "kind": "Expansion", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/37ca3555-c135-4a73-a65e-9c1d00323f5d", + "name": "37ca3555-c135-4a73-a65e-9c1d00323f5d", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Expansion", + "properties": { + "queryTemplate": "let AccountActivity_byIP = (v_IP_Address:string){\r\n AzureActivity\r\n | where Caller != '' and CallerIpAddress == v_IP_Address\r\n | summarize Account_Aux_StartTime = min(TimeGenerated), Account_Aux_EndTime = max(TimeGenerated), Count = count() by Caller, TenantId\r\n | top 10 by Count asc nulls last \r\n | extend UPN = iff(Caller contains '@', Caller, ''), Account_AadUserId = iff(Caller !contains '@', Caller,'')\r\n | extend Account_Name = split(UPN,'@')[0] , Account_UPNSuffix = split(UPN,'@')[1]\r\n | project Account_Name, Account_UPNSuffix, Account_AadUserId, Account_AadTenantId=TenantId, Account_Aux_StartTime , Account_Aux_EndTime};\r\n AccountActivity_byIP('
')", + "inputFields": [ + "address" + ], + "outputEntityTypes": [ + "Account" + ], + "dataSources": [ + "AzureActivity" + ], + "inputEntityType": "IP", + "displayName": "Least active accounts on Azure from this IP" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/97a1d515-abf2-4231-9a35-985f9de0bb91", + "name": "97a1d515-abf2-4231-9a35-985f9de0bb91", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Expansion", + "properties": { + "queryTemplate": "let AccountActivity_byIP = (v_IP_Address:string){\r\n AzureActivity\r\n | where Caller != '' and CallerIpAddress == v_IP_Address\r\n | summarize Account_Aux_StartTime = min(TimeGenerated), Account_Aux_EndTime = max(TimeGenerated), Count = count() by Caller, TenantId\r\n | top 10 by Count desc nulls last \r\n | extend UPN = iff(Caller contains '@', Caller, ''), Account_AadUserId = iff(Caller !contains '@', Caller,'')\r\n | extend Account_Name = split(UPN,'@')[0] , Account_UPNSuffix = split(UPN,'@')[1]\r\n | project Account_Name, Account_UPNSuffix, Account_AadUserId, Account_AadTenantId=TenantId, Account_Aux_StartTime , Account_Aux_EndTime};\r\n AccountActivity_byIP('
')", + "inputFields": [ + "address" + ], + "outputEntityTypes": [ + "Account" + ], + "dataSources": [ + "AzureActivity" + ], + "inputEntityType": "IP", + "displayName": "Most active accounts on Azure from this IP" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json new file mode 100644 index 000000000000..40ed9f45b346 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueries/GetExpansionEntityQueryById.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityQueryId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueries/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueries", + "etag": null, + "kind": "Expansion", + "properties": { + "queryTemplate": "let GetParentProcessesOnHost = (v_Host_HostName:string){\r\n SecurityEvent \r\n | where EventID == 4688 \r\n | where isnotempty(ParentProcessName)\r\n | where NewProcessName !contains ':\\\\Windows\\\\System32\\\\conhost.exe' and ParentProcessName !contains ':\\\\Windows\\\\System32\\\\conhost.exe'\r\n and NewProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\csc.exe' and ParentProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\csc.exe'\r\n and NewProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\cvtres.exe' and ParentProcessName !contains ':\\\\Windows\\\\Microsoft.NET\\\\Framework64\\\\v2.0.50727\\\\cvtres.exe'\r\n and NewProcessName!contains ':\\\\Program Files\\\\Microsoft Monitoring Agent\\\\Agent\\\\MonitoringHost.exe' and ParentProcessName !contains ':\\\\Program Files\\\\Microsoft Monitoring Agent\\\\Agent\\\\MonitoringHost.exe'\r\n and ParentProcessName !contains ':\\\\Windows\\\\CCM\\\\CcmExec.exe'\r\n | where(ParentProcessName !contains ':\\\\Windows\\\\System32\\\\svchost.exe' and (NewProcessName !contains ':\\\\Windows\\\\System32\\\\wbem\\\\WmiPrvSE.exe' or NewProcessName !contains ':\\\\Windows\\\\SysWOW64\\\\wbem\\\\WmiPrvSE.exe'))\r\n | where(ParentProcessName !contains ':\\\\Windows\\\\System32\\\\services.exe' and NewProcessName !contains ':\\\\Windows\\\\servicing\\\\TrustedInstaller.exe')\r\n | where toupper(Computer) contains v_Host_HostName or toupper(WorkstationName) contains v_Host_HostName\r\n | summarize min(TimeGenerated), max(TimeGenerated) by Account, Computer, ParentProcessName, NewProcessName, CommandLine, ProcessId\r\n | project min_TimeGenerated, max_TimeGenerated, Account, Computer, ParentProcessName, NewProcessName, CommandLine, ProcessId\r\n | project-rename Process_Host_UnstructuredName=Computer, Process_Account_UnstructuredName=Account, Process_CommandLine=CommandLine, Process_ProcessId=ProcessId, Process_ImageFile_FullPath=NewProcessName, Process_ParentProcess_ImageFile_FullPath=ParentProcessName\r\n | top 10 by min_TimeGenerated asc};\r\n GetParentProcessesOnHost(toupper(''))", + "inputFields": [ + "hostName" + ], + "outputEntityTypes": [ + "Process" + ], + "dataSources": [ + "SecurityEvent" + ], + "inputEntityType": "Host", + "displayName": "Parent processes running on host" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json new file mode 100644 index 000000000000..67ee2d194ab2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueryTemplates/GetActivityEntityQueryTemplateById.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityQueryTemplateId": "07da3cc8-c8ad-4710-a44e-334cdcb7882b" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueryTemplates/07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "name": "07da3cc8-c8ad-4710-a44e-334cdcb7882b", + "type": "Microsoft.SecurityInsights/entityQueryTemplate", + "kind": "Activity", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "dataTypes": [ + { + "dataType": "AuditLogs" + }, + { + "dataType": "SecurityEvent" + } + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json new file mode 100644 index 000000000000..759a8f8a8638 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/entityQueryTemplates/GetEntityQueryTemplates.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "kind": "Activity", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueryTemplates/37ca3555-c135-4a73-a65e-9c1d00323f5d", + "name": "37ca3555-c135-4a73-a65e-9c1d00323f5d", + "type": "Microsoft.SecurityInsights/entityQueryTemplates", + "kind": "Activity", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "dataTypes": [ + { + "dataType": "AuditLogs" + }, + { + "dataType": "SecurityEvent" + } + ] + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entityQueryTemplates/97a1d515-abf2-4231-9a35-985f9de0bb91", + "name": "97a1d515-abf2-4231-9a35-985f9de0bb91", + "type": "Microsoft.SecurityInsights/entityQueryTemplates", + "kind": "Activity", + "properties": { + "title": "An account was deleted on this host", + "content": "On '{{Computer}}' the account '{{TargetAccount}}' was deleted by '{{AddedBy}}'", + "description": "Account deleted on host", + "queryDefinitions": { + "query": "let GetAccountActions = (v_Host_Name:string, v_Host_NTDomain:string, v_Host_DnsDomain:string, v_Host_AzureID:string, v_Host_OMSAgentID:string){\nSecurityEvent\n| where EventID in (4725, 4726, 4767, 4720, 4722, 4723, 4724)\n// parsing for Host to handle variety of conventions coming from data\n| extend Host_HostName = case(\nComputer has '@', tostring(split(Computer, '@')[0]),\nComputer has '\\\\', tostring(split(Computer, '\\\\')[1]),\nComputer has '.', tostring(split(Computer, '.')[0]),\nComputer\n)\n| extend Host_NTDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', tostring(split(Computer, '.')[-2]), \nComputer\n)\n| extend Host_DnsDomain = case(\nComputer has '\\\\', tostring(split(Computer, '\\\\')[0]), \nComputer has '.', strcat_array(array_slice(split(Computer,'.'),-2,-1),'.'), \nComputer\n)\n| where (Host_HostName =~ v_Host_Name and Host_NTDomain =~ v_Host_NTDomain) \nor (Host_HostName =~ v_Host_Name and Host_DnsDomain =~ v_Host_DnsDomain) \nor v_Host_AzureID =~ _ResourceId \nor v_Host_OMSAgentID == SourceComputerId\n| project TimeGenerated, EventID, Activity, Computer, TargetAccount, TargetUserName, TargetDomainName, TargetSid, SubjectUserName, SubjectUserSid, _ResourceId, SourceComputerId\n| extend AddedBy = SubjectUserName\n// Future support for Activities\n| extend timestamp = TimeGenerated, HostCustomEntity = Computer, AccountCustomEntity = TargetAccount\n};\nGetAccountActions('{{Host_HostName}}', '{{Host_NTDomain}}', '{{Host_DnsDomain}}', '{{Host_AzureID}}', '{{Host_OMSAgentID}}')\n \n| where EventID == 4726 " + }, + "inputEntityType": "Host", + "requiredInputFieldsSets": [ + [ + "Host_HostName", + "Host_NTDomain" + ], + [ + "Host_HostName", + "Host_DnsDomain" + ], + [ + "Host_AzureID" + ], + [ + "Host_OMSAgentID" + ] + ], + "entitiesFilter": { + "Host_OsFamily": [ + "Windows" + ] + }, + "dataTypes": [ + { + "dataType": "AuditLogs" + }, + { + "dataType": "SecurityEvent" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/CreateFileImport.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/CreateFileImport.json new file mode 100644 index 000000000000..32dcfa4f24b9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/CreateFileImport.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "fileImportId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "fileImport": { + "properties": { + "source": "mySource", + "importFile": { + "fileName": "myFile.json", + "fileSize": 4653, + "fileFormat": "JSON" + }, + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/FileImports", + "properties": { + "importFile": { + "fileName": "myFile.json", + "fileSize": 4653, + "fileFormat": "JSON", + "fileContentUri": "https://sentinelimportswus2.blob.core.windows.net/78c2e51a-3cd3-4ca0-a2d4-e7effb9a05fe/43967a5e-47a7-474e-afb8-2081e9b99ca1/fileName.json?skoid=40ca3ff4-ed1d-4c65-a409-8c6caff8a6d5&sktid=72f988bf-86f1-41af-91ab-2d7cd011db47&skt=2022-03-25T21%3A12%3A51Z&ske=2022-03-25T22%3A12%3A51Z&sks=b&skv=2020-10-02&sv=2020-08-04&st=2022-03-25T21%3A12%3A51Z&se=2022-03-25T22%3A12%3A51Z&sr=b&sp=c&sig=5n0D%2FERS6ZOQdfdO2adleeSVOM4b6mQeds%2FWYCGm9pU%3D", + "deleteStatus": "NotDeleted" + }, + "state": "WaitingForUpload", + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords", + "totalRecordCount": null, + "validRecordCount": null, + "ingestedRecordCount": null, + "createdTimeUTC": "2022-04-04T20:05:59.847136Z", + "filesValidUntilTimeUTC": "2022-04-05T20:05:59.8471361Z", + "importValidUntilTimeUTC": "2022-05-04T20:05:59.8471366Z", + "source": "mySource" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/DeleteFileImport.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/DeleteFileImport.json new file mode 100644 index 000000000000..aaa6f3f81cfd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/DeleteFileImport.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "fileImportId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/FileImports", + "properties": { + "importFile": { + "fileName": "myFile.json", + "fileSize": 5146, + "fileFormat": "JSON", + "fileContentUri": null, + "deleteStatus": "NotDeleted" + }, + "state": "Ingested", + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords", + "totalRecordCount": 5, + "validRecordCount": 5, + "ingestedRecordCount": 5, + "createdTimeUTC": "2022-03-25T21:02:38.8350631Z", + "filesValidUntilTimeUTC": "2022-03-26T21:02:38.8350632Z", + "importValidUntilTimeUTC": "2022-04-24T21:02:38.8350636Z", + "source": "mySource" + } + } + }, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/GetFileImportById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/GetFileImportById.json new file mode 100644 index 000000000000..519a28014338 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/GetFileImportById.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "fileImportId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/FileImports", + "properties": { + "importFile": { + "fileName": "myFile.json", + "fileSize": 5146, + "fileFormat": "JSON", + "fileContentUri": "https://sentinelimportswus2.blob.core.windows.net/78c2e51a-3cd3-4ca0-a2d4-e7effb9a05fe/43967a5e-47a7-474e-afb8-2081e9b99ca1/myFile.json?skoid=40ca3ff4-ed1d-4c65-a409-8c6caff8a6d5&sktid=72f988bf-86f1-41af-91ab-2d7cd011db47&skt=2022-03-25T21%3A12%3A51Z&ske=2022-03-25T22%3A12%3A51Z&sks=b&skv=2020-10-02&sv=2020-08-04&st=2022-03-25T21%3A12%3A51Z&se=2022-03-25T22%3A12%3A51Z&sr=b&sp=c&sig=5n0D%2FERS6ZOQdfdO2adleeSVOM4b6mQeds%2FWYCGm9pU%3D", + "deleteStatus": "NotDeleted" + }, + "state": "Ingested", + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords", + "totalRecordCount": 5, + "validRecordCount": 5, + "ingestedRecordCount": 5, + "createdTimeUTC": "2022-03-25T21:02:38.8350631Z", + "filesValidUntilTimeUTC": "2022-03-26T21:02:38.8350632Z", + "importValidUntilTimeUTC": "2022-04-24T21:02:38.8350636Z", + "source": "mySource" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/GetFileImports.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/GetFileImports.json new file mode 100644 index 000000000000..31c4ec44e648 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/fileImports/GetFileImports.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "$orderby": "properties/createdTimeUtc desc", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/FileImports/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/FileImports", + "properties": { + "importFile": { + "fileName": "fileName.json", + "fileSize": 5146, + "fileFormat": "JSON", + "fileContentUri": null, + "deleteStatus": "NotDeleted" + }, + "state": "Ingested", + "contentType": "StixIndicator", + "ingestionMode": "IngestAnyValidRecords", + "totalRecordCount": 5, + "validRecordCount": 5, + "ingestedRecordCount": 5, + "createdTimeUTC": "2022-03-25T21:02:38.8350631Z", + "filesValidUntilTimeUTC": "2022-03-26T21:02:38.8350632Z", + "importValidUntilTimeUTC": "2022-04-24T21:02:38.8350636Z", + "source": "mySource" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHunt.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHunt.json new file mode 100644 index 000000000000..2364e053da2c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHunt.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "hunt": { + "properties": { + "displayName": "Log4J new hunt", + "description": "Log4J Hunt Description", + "status": "New", + "hypothesisStatus": "Unknown", + "attackTactics": [ + "Reconnaissance" + ], + "attackTechniques": [ + "T1595" + ], + "labels": [ + "Label1", + "Label2" + ], + "owner": { + "objectId": "873b5263-5d34-4149-b356-ad341b01e123" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f", + "name": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "etag": "\"de00c408-0000-0c00-0000-62741e350000\"", + "type": "Microsoft.SecurityInsights/hunts", + "properties": { + "displayName": "Log4J new hunt", + "description": "Log4J Hunt Description", + "status": "New", + "hypothesisStatus": "Unknown", + "attackTactics": [ + "Reconnaissance" + ], + "attackTechniques": [ + "T1595" + ], + "huntStartTimeUtc": "2022-03-11T09:47:15.438Z", + "huntEndTimeUtc": "2022-03-12T09:47:15.438Z", + "labels": [ + "Label1", + "Label2" + ], + "owner": { + "objectId": "873b5263-5d34-4149-b356-ad341b01e123", + "email": "testemail@microsoft.com", + "assignedTo": null, + "userPrincipalName": "John Doe", + "ownerType": "User" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f", + "name": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "etag": "\"de00c408-0000-0c00-0000-62741e350000\"", + "type": "Microsoft.SecurityInsights/hunts", + "properties": { + "displayName": "Log4J new hunt", + "description": "Log4J Hunt Description", + "status": "New", + "hypothesisStatus": "Unknown", + "attackTactics": [ + "Reconnaissance" + ], + "attackTechniques": [ + "T1595" + ], + "huntSequenceNumber": 0, + "huntStartTimeUtc": "2022-03-11T09:47:15.438Z", + "huntEndTimeUtc": "2022-03-12T09:47:15.438Z", + "labels": [ + "Label1", + "Label2" + ], + "owner": { + "objectId": "873b5263-5d34-4149-b356-ad341b01e123", + "email": "testemail@microsoft.com", + "assignedTo": null, + "userPrincipalName": "John Doe", + "ownerType": "User" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHuntComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHuntComment.json new file mode 100644 index 000000000000..737fdf03c20b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHuntComment.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntCommentId": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "huntComment": { + "properties": { + "message": "This is a test comment." + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/comments/2216d0e1-91e3-4902-89fd-d2df8c123456", + "name": "2216d0e1-91e3-4902-89fd-d2df8c123456", + "etag": "\"3102f74d-0000-0c00-0000-629e6e050000\"", + "type": "Microsoft.SecurityInsights/hunts/comments", + "systemData": { + "createdAt": "2021-08-15T16:42:38.8709453Z", + "createdBy": "testuser@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T16:42:38.8709453Z", + "lastModifiedBy": "testuser@microsoft.com", + "lastModifiedByType": "User" + }, + "properties": { + "message": "This is a test comment." + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/comments/2216d0e1-91e3-4902-89fd-d2df8c123456", + "name": "2216d0e1-91e3-4902-89fd-d2df8c123456", + "etag": "\"3102f74d-0000-0c00-0000-629e6e050000\"", + "type": "Microsoft.SecurityInsights/hunts/comments", + "systemData": { + "createdAt": "2021-08-15T16:42:38.8709453Z", + "createdBy": "testuser@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T16:42:38.8709453Z", + "lastModifiedBy": "testuser@microsoft.com", + "lastModifiedByType": "User" + }, + "properties": { + "message": "This is a test comment." + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHuntRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHuntRelation.json new file mode 100644 index 000000000000..007c9f2c24da --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/CreateHuntRelation.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntRelationId": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "huntRelation": { + "properties": { + "relatedResourceId": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "labels": [ + "Test Label" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/relations/2216d0e1-91e3-4902-89fd-d2df8c535096", + "name": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "etag": "\"26012da2-0000-0c00-0000-627ad2760000\"", + "type": "Microsoft.SecurityInsights/hunts/relations", + "properties": { + "relatedResourceId": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/Bookmarks", + "labels": [ + "Test Label" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/relations/2216d0e1-91e3-4902-89fd-d2df8c535096", + "name": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "etag": "\"26012da2-0000-0c00-0000-627ad2760000\"", + "type": "Microsoft.SecurityInsights/hunts/relations", + "properties": { + "relatedResourceId": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/Bookmarks", + "labels": [ + "Test Label" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHunt.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHunt.json new file mode 100644 index 000000000000..8c849a752e28 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHunt.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHuntComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHuntComment.json new file mode 100644 index 000000000000..b54ead1fdafb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHuntComment.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntCommentId": "2216d0e1-91e3-4902-89fd-d2df8c123456" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHuntRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHuntRelation.json new file mode 100644 index 000000000000..5dc09b3d57fa --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/DeleteHuntRelation.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntRelationId": "2216d0e1-91e3-4902-89fd-d2df8c535096" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntById.json new file mode 100644 index 000000000000..d00f441942cf --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntById.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f", + "name": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "etag": "\"de00c408-0000-0c00-0000-62741e350000\"", + "type": "Microsoft.SecurityInsights/hunts", + "properties": { + "displayName": "Log4J new hunt ", + "description": "Log4J Hunt Description", + "status": "New", + "hypothesisStatus": "Unknown", + "attackTactics": [ + "Reconnaissance" + ], + "attackTechniques": [ + "T1595" + ], + "labels": [ + "Label1", + "Label2" + ], + "owner": { + "objectId": "873b5263-5d34-4149-b356-ad341b01e123", + "email": "testemail@microsoft.com", + "assignedTo": null, + "userPrincipalName": "John Doe", + "ownerType": "User" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntCommentById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntCommentById.json new file mode 100644 index 000000000000..84342830356d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntCommentById.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntCommentId": "2216d0e1-91e3-4902-89fd-d2df8c535096" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/comments/2216d0e1-91e3-4902-89fd-d2df8c123456", + "name": "2216d0e1-91e3-4902-89fd-d2df8c123456", + "etag": "\"3102f74d-0000-0c00-0000-629e6e050000\"", + "type": "Microsoft.SecurityInsights/hunts/comments", + "systemData": { + "createdAt": "2021-08-15T16:42:38.8709453Z", + "createdBy": "testuser@microsoft.com", + "createdByType": "User", + "lastModifiedAt": "2021-08-19T16:42:38.8709453Z", + "lastModifiedBy": "testuser@microsoft.com", + "lastModifiedByType": "User" + }, + "properties": { + "message": "This is a comment." + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntComments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntComments.json new file mode 100644 index 000000000000..c11fefefb151 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntComments.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/comments/2216d0e1-91e3-4902-89fd-d2df8c123456", + "name": "2216d0e1-91e3-4902-89fd-d2df8c123456", + "etag": "\"3102f74d-0000-0c00-0000-629e6e050000\"", + "type": "Microsoft.SecurityInsights/hunts/comments", + "properties": { + "message": "This is a test comment." + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntRelationById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntRelationById.json new file mode 100644 index 000000000000..d80d910524f8 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntRelationById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f", + "huntRelationId": "2216d0e1-91e3-4902-89fd-d2df8c535096" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/relations/2216d0e1-91e3-4902-89fd-d2df8c535096", + "name": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "etag": "\"26012da2-0000-0c00-0000-627ad2760000\"", + "type": "Microsoft.SecurityInsights/hunts/relations", + "properties": { + "relatedResourceId": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/Bookmarks", + "labels": [ + "label1" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntRelations.json new file mode 100644 index 000000000000..8aab5f492710 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHuntRelations.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "huntId": "163e7b2a-a2ec-4041-aaba-d878a38f265f" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/hunts/163e7b2a-a2ec-4041-aaba-d878a38f265f/relations/2216d0e1-91e3-4902-89fd-d2df8c535096", + "name": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "etag": "\"26012da2-0000-0c00-0000-627ad2760000\"", + "type": "Microsoft.SecurityInsights/hunts/relations", + "properties": { + "relatedResourceId": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirint/providers/Microsoft.SecurityInsights/Bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/Bookmarks", + "labels": [ + "label1" + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHunts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHunts.json new file mode 100644 index 000000000000..c4d6ec7fda64 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/hunts/GetHunts.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/hunts/b372ee75-2cad-4b71-8917-d5d5df9315b5", + "name": "b372ee75-2cad-4b71-8917-d5d5df9315b5", + "etag": "\"de00c408-0000-0c00-0000-62741e350000\"", + "type": "Microsoft.SecurityInsights/hunts", + "properties": { + "displayName": "Log4J new hunt", + "description": "Log4J Hunt Description", + "status": "New", + "hypothesisStatus": "Unknown", + "attackTactics": [ + "Reconnaissance" + ], + "attackTechniques": [ + "T1595" + ], + "labels": [ + "Label1", + "Label2" + ], + "owner": { + "objectId": "873b5263-5d34-4149-b356-ad341b01e123", + "email": "testemail@microsoft.com", + "assignedTo": null, + "userPrincipalName": "John Doe", + "ownerType": "User" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json new file mode 100644 index 000000000000..4c48c3e5a84c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentAlerts/Incidents_ListAlerts.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "69a30280-6a4c-4aa7-9af0-5d63f335d600" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRG/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Entities/baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "name": "baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "SecurityAlert", + "properties": { + "systemAlertId": "baa8a239-6fde-4ab7-a093-d09f7b75c58c", + "tactics": [], + "alertDisplayName": "myAlert", + "confidenceLevel": "Unknown", + "severity": "Low", + "vendorName": "Microsoft", + "productName": "Azure Security Center", + "alertType": "myAlert", + "processingEndTime": "2020-07-20T18:21:53.615Z", + "status": "New", + "endTimeUtc": "2020-07-20T18:21:53.615Z", + "startTimeUtc": "2020-07-20T18:21:53.615Z", + "timeGenerated": "2020-07-20T18:21:53.615Z", + "resourceIdentifiers": [ + { + "type": "LogAnalytics", + "workspaceId": "c8c99641-985d-4e4e-8e91-fb3466cd0e5b", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroup": "myRG" + } + ], + "additionalData": { + "alertMessageEnqueueTime": "2020-07-20T18:21:57.304Z" + }, + "friendlyName": "myAlert" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json new file mode 100644 index 000000000000..0983eff10e2f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentBookmarks/Incidents_ListBookmarks.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "69a30280-6a4c-4aa7-9af0-5d63f335d600" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/afbd324f-6c48-459c-8710-8d1e1cd03812", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Bookmark", + "properties": { + "displayName": "SecurityEvent - 868f40f4698d", + "created": "2020-06-17T15:34:01.426+00:00", + "updated": "2020-06-17T15:34:01.426+00:00", + "createdBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@contoso.com", + "name": "user" + }, + "updatedBy": { + "objectId": "b03ca914-5eb6-45e5-9417-fe0797c372fd", + "email": "user@contoso.com", + "name": "user" + }, + "eventTime": "2020-06-17T15:34:01.426+00:00", + "labels": [], + "query": "SecurityEvent\r\n| take 1\n", + "queryResult": "{\"TimeGenerated\":\"2020-05-24T01:24:25.67Z\",\"Account\":\"\\\\ADMINISTRATOR\",\"AccountType\":\"User\",\"Computer\":\"SecurityEvents\",\"EventSourceName\":\"Microsoft-Windows-Security-Auditing\",\"Channel\":\"Security\",\"Task\":12544,\"Level\":\"16\",\"EventID\":4625,\"Activity\":\"4625 - An account failed to log on.\",\"AuthenticationPackageName\":\"NTLM\",\"FailureReason\":\"%%2313\",\"IpAddress\":\"176.113.115.73\",\"IpPort\":\"0\",\"LmPackageName\":\"-\",\"LogonProcessName\":\"NtLmSsp \",\"LogonType\":3,\"LogonTypeName\":\"3 - Network\",\"Process\":\"-\",\"ProcessId\":\"0x0\",\"__entityMapping\":{\"\\\\ADMINISTRATOR\":\"Account\",\"SecurityEvents\":\"Host\"}}", + "additionalData": { + "eTag": "\"3b00acab-0000-0d00-0000-5f15e4ed0000\"", + "entityId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "friendlyName": "SecurityEvent - 868f40f4698d" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json new file mode 100644 index 000000000000..f88b13e4fddd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_CreateOrUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "incidentComment": { + "properties": { + "message": "Some message" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json new file mode 100644 index 000000000000..2446af99a75c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json new file mode 100644 index 000000000000..ab97dc05cb6b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json new file mode 100644 index 000000000000..56a80dd12ce0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentComments/IncidentComments_List.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json new file mode 100644 index 000000000000..3e5107fcaf0a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentEntities/Incidents_ListEntities.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "69a30280-6a4c-4aa7-9af0-5d63f335d600" + }, + "responses": { + "200": { + "body": { + "entities": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Entities/e1d3d618-e11f-478b-98e3-bb381539a8e1", + "name": "e1d3d618-e11f-478b-98e3-bb381539a8e1", + "type": "Microsoft.SecurityInsights/Entities", + "kind": "Account", + "properties": { + "accountName": "administrator", + "ntDomain": "domain", + "friendlyName": "administrator" + } + } + ], + "metaData": [ + { + "entityKind": "Account", + "count": 1 + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json new file mode 100644 index 000000000000..be8695b8215c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_CreateOrUpdate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentTaskId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "incidentTask": { + "properties": { + "title": "Task title", + "description": "Task description", + "status": "New" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/tasks/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/tasks", + "properties": { + "title": "Task title", + "description": "Task description", + "status": "New", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/tasks/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/tasks", + "properties": { + "title": "Task title", + "description": "Task description", + "status": "New", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json new file mode 100644 index 000000000000..b2f360e5f5d6 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentTaskId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json new file mode 100644 index 000000000000..ba821473a564 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_Get.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentTaskId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/tasks/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/tasks", + "properties": { + "title": "Task title", + "description": "Task description", + "status": "New", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json new file mode 100644 index 000000000000..a22e2f34ce1c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTasks/IncidentTasks_List.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/tasks/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "type": "Microsoft.SecurityInsights/incidents/tasks", + "properties": { + "title": "Task title", + "description": "Task description", + "status": "New", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastModifiedTimeUtc": "2019-01-03T11:10:30Z", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + }, + "lastModifiedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "name": "john doe", + "userPrincipalName": "john@contoso.com" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json new file mode 100644 index 000000000000..db7535bdcefd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/IncidentTeam/Incidents_CreateTeam.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "69a30280-6a4c-4aa7-9af0-5d63f335d600", + "teamProperties": { + "teamName": "Team name", + "teamDescription": "Team description", + "groupIds": null, + "memberIds": null + } + }, + "responses": { + "200": { + "body": { + "teamId": "99978838-9bda-4ad4-8f93-4cf7ebc50ca5", + "primaryChannelUrl": "https://teams.microsoft.com/l/team/19:80bf3b25485b4067b7d2dc4eec9e1578%40thread.tacv2/conversations?groupId=99978838-9bda-4ad4-8f93-4cf7ebc50ca5&tenantId=5b5a146c-eba8-46af-96f8-e31b50d15a3f", + "teamCreationTimeUtc": "2021-03-15T17:08:21.995Z", + "name": "Team name", + "description": "Team description" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_CreateOrUpdate.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_CreateOrUpdate.json new file mode 100644 index 000000000000..dd8d8ee8145d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_CreateOrUpdate.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incident": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "title": "My incident", + "description": "This is a demo incident", + "severity": "High", + "status": "Closed", + "classification": "FalsePositive", + "classificationReason": "InaccurateData", + "classificationComment": "Not a malicious activity", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": null, + "assignedTo": null, + "userPrincipalName": null, + "ownerType": null + }, + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0001\"", + "type": "Microsoft.SecurityInsights/incidents", + "properties": { + "title": "My incident", + "description": "This is a demo incident", + "severity": "High", + "status": "Closed", + "classification": "FalsePositive", + "classificationReason": "InaccurateData", + "classificationComment": "Not a malicious activity", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "assignedTo": "john doe", + "userPrincipalName": "john@contoso.com", + "ownerType": "User" + }, + "labels": [], + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "incidentNumber": 3177, + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ], + "techniques": [ + "T1091", + "T1133", + "T1053" + ], + "providerIncidentUrl": "https://security.microsoft.com/incidents/3177?tid=5b5a146c-eba8-46af-96f8-e31b50d15a3f" + }, + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "providerName": "Azure Sentinel", + "providerIncidentId": "3177" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0001\"", + "type": "Microsoft.SecurityInsights/incidents", + "properties": { + "title": "My incident", + "description": "This is a demo incident", + "severity": "High", + "status": "Closed", + "classification": "FalsePositive", + "classificationReason": "InaccurateData", + "classificationComment": "Not a malicious activity", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "assignedTo": "john doe", + "userPrincipalName": "john@contoso.com", + "ownerType": "User" + }, + "labels": [], + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "incidentNumber": 3177, + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ], + "techniques": [ + "T1091", + "T1133", + "T1053" + ], + "providerIncidentUrl": "https://security.microsoft.com/incidents/3177?tid=5b5a146c-eba8-46af-96f8-e31b50d15a3f" + }, + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "providerName": "Azure Sentinel", + "providerIncidentId": "3177" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_Delete.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_Delete.json new file mode 100644 index 000000000000..de781b48306c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_Get.json new file mode 100644 index 000000000000..081f78968d11 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_Get.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/incidents", + "properties": { + "title": "My incident", + "description": "This is a demo incident", + "severity": "High", + "status": "Closed", + "classification": "FalsePositive", + "classificationReason": "InaccurateData", + "classificationComment": "Not a malicious activity", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "assignedTo": "john doe", + "userPrincipalName": "john@contoso.com", + "ownerType": "User" + }, + "labels": [], + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "incidentNumber": 3177, + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ], + "techniques": [ + "T1091", + "T1133", + "T1053" + ], + "providerIncidentUrl": "https://security.microsoft.com/incidents/3177?tid=5b5a146c-eba8-46af-96f8-e31b50d15a3f" + }, + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "providerName": "Azure Sentinel", + "providerIncidentId": "3177" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_List.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_List.json new file mode 100644 index 000000000000..ce75c99f9c30 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/Incidents_List.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "$orderby": "properties/createdTimeUtc desc", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/incidents", + "properties": { + "title": "My incident", + "description": "This is a demo incident", + "severity": "High", + "status": "Closed", + "classification": "FalsePositive", + "classificationReason": "InaccurateData", + "classificationComment": "Not a malicious activity", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "assignedTo": "john doe", + "userPrincipalName": "john@contoso.com", + "ownerType": "User" + }, + "labels": [], + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "incidentNumber": 3177, + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ], + "techniques": [ + "T1091", + "T1133", + "T1053" + ], + "providerIncidentUrl": "https://security.microsoft.com/incidents/3177?tid=5b5a146c-eba8-46af-96f8-e31b50d15a3f" + }, + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "providerName": "Azure Sentinel", + "providerIncidentId": "3177" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/CreateIncidentRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/CreateIncidentRelation.json new file mode 100644 index 000000000000..1a078266cc55 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/CreateIncidentRelation.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "relation": { + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/DeleteIncidentRelation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/DeleteIncidentRelation.json new file mode 100644 index 000000000000..7ebb5719c8df --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/DeleteIncidentRelation.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/GetAllIncidentRelations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/GetAllIncidentRelations.json new file mode 100644 index 000000000000..6b75807674db --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/GetAllIncidentRelations.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/9673a17d-8bc7-4ca6-88ee-38a4f3efc032", + "name": "9673a17d-8bc7-4ca6-88ee-38a4f3efc032", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "6f714025-dd7c-46aa-b5d0-b9857488d060", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/entities/1dd267cd-8a1f-4f6f-b92c-da43ac8819af", + "relatedResourceName": "1dd267cd-8a1f-4f6f-b92c-da43ac8819af", + "relatedResourceType": "Microsoft.SecurityInsights/entities", + "relatedResourceKind": "SecurityAlert" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/GetIncidentRelationByName.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/GetIncidentRelationByName.json new file mode 100644 index 000000000000..adf5b993ac6a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/incidents/relations/GetIncidentRelationByName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/afbd324f-6c48-459c-8710-8d1e1cd03812/relations/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/relations", + "etag": "190057d0-0000-0d00-0000-5c6f5adb0000", + "properties": { + "relatedResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceName": "2216d0e1-91e3-4902-89fd-d2df8c535096", + "relatedResourceType": "Microsoft.SecurityInsights/bookmarks" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/manualTrigger/Entities_RunPlaybook.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/manualTrigger/Entities_RunPlaybook.json new file mode 100644 index 000000000000..4fb355932ce9 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/manualTrigger/Entities_RunPlaybook.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "entityIdentifier": "72e01a22-5cd2-4139-a149-9f2736ff2ar2", + "manualTriggerRequestBody": { + "logicAppsResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/my-playbook-name", + "tenantId": "qwere6b2-9ac0-4464-9919-dccaee2e4ddd", + "incidentArmId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5" + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json new file mode 100644 index 000000000000..e98a75163fce --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/manualTrigger/Incidents_RunPlaybook.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentIdentifier": "73e01a99-5cd7-4139-a149-9f2736ff2ar4", + "manualTriggerRequestBody": { + "logicAppsResourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Logic/workflows/my-playbook-name", + "tenantId": "qwere6b2-9ac0-4464-9919-dccaee2e4ddd" + } + }, + "responses": { + "204": { + "body": {} + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/DeleteMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/DeleteMetadata.json new file mode 100644 index 000000000000..380bf95aee42 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/DeleteMetadata.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "metadataName": "metadataName" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetAllMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetAllMetadata.json new file mode 100644 index 000000000000..2d804a302dd5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetAllMetadata.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName1", + "name": "metadataName1", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + } + } + }, + { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName2", + "name": "metadataName2", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "f5160682-0e10-4e23-8fcf-df3df49c5522", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName2", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + } + } + }, + { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.Insights/workbooks/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName3", + "name": "metadataName3", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "f593501d-ec01-4057-8146-a1de35c461ef", + "version": "1.0.0.0", + "kind": "Workbook", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.Insights/workbooks/workbookName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetAllMetadataOData.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetAllMetadataOData.json new file mode 100644 index 000000000000..2e76625b1963 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetAllMetadataOData.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ODataFilter": "properties/kind eq 'AnalyticsRule'", + "ODataOrderBy": "properties/parentId desc", + "ODataSkip": "2", + "ODataTop": "2" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName1", + "name": "metadataName1", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName1", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + } + } + }, + { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName2", + "name": "metadataName2", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "f5160682-0e10-4e23-8fcf-df3df49c5522", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName2", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetMetadata.json new file mode 100644 index 000000000000..196a98c55a64 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/GetMetadata.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "2e1dc338-d04d-4443-b721-037eff4fdcac", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "metadataName": "metadataName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + }, + "author": { + "name": "User Name", + "email": "email@microsoft.com" + }, + "support": { + "name": "Microsoft", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/", + "tier": "Partner" + }, + "dependencies": { + "operator": "AND", + "criteria": [ + { + "operator": "OR", + "criteria": [ + { + "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", + "kind": "DataConnector" + }, + { + "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", + "kind": "DataConnector" + }, + { + "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", + "kind": "DataConnector", + "version": "2.0" + } + ] + }, + { + "kind": "Playbook", + "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", + "version": "1.0" + }, + { + "kind": "Parser", + "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" + } + ] + }, + "categories": { + "domains": [ + "Application", + "Security – Insider Threat" + ], + "verticals": [ + "Healthcare" + ] + }, + "providers": [ + "Amazon", + "Microsoft" + ], + "firstPublishDate": "2021-05-18", + "lastPublishDate": "2021-05-18", + "previewImages": [ + "firstImage.png", + "secondImage.jpeg" + ], + "previewImagesDark": [ + "firstImageDark.png", + "secondImageDark.jpeg" + ], + "contentSchemaVersion": "2.0", + "customVersion": "1.0", + "threatAnalysisTactics": [ + "reconnaissance", + "commandandcontrol" + ], + "threatAnalysisTechniques": [ + "T1548", + "T1548.001" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PatchMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PatchMetadata.json new file mode 100644 index 000000000000..8cb1d9933b69 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PatchMetadata.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "metadataName": "metadataName", + "metadataPatch": { + "properties": { + "author": { + "name": "User Name", + "email": "email@microsoft.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "author": { + "name": "User Name", + "email": "email@microsoft.com" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PutMetadata.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PutMetadata.json new file mode 100644 index 000000000000..3442859f5d9a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PutMetadata.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "metadataName": "metadataName", + "metadata": { + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + }, + "author": { + "name": "User Name", + "email": "email@microsoft.com" + }, + "support": { + "name": "Microsoft", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/", + "tier": "Partner" + }, + "dependencies": { + "operator": "AND", + "criteria": [ + { + "operator": "OR", + "criteria": [ + { + "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", + "kind": "DataConnector", + "name": "Microsoft Defender for Endpoint" + }, + { + "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", + "kind": "DataConnector" + }, + { + "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", + "kind": "DataConnector", + "version": "2.0" + } + ] + }, + { + "kind": "Playbook", + "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", + "version": "1.0" + }, + { + "kind": "Parser", + "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" + } + ] + }, + "categories": { + "domains": [ + "Application", + "Security – Insider Threat" + ], + "verticals": [ + "Healthcare" + ] + }, + "providers": [ + "Amazon", + "Microsoft" + ], + "firstPublishDate": "2021-05-18", + "lastPublishDate": "2021-05-18", + "previewImages": [ + "firstImage.png", + "secondImage.jpeg" + ], + "previewImagesDark": [ + "firstImageDark.png", + "secondImageDark.jpeg" + ], + "contentSchemaVersion": "2.0", + "customVersion": "1.0", + "threatAnalysisTactics": [ + "reconnaissance", + "commandandcontrol" + ], + "threatAnalysisTechniques": [ + "T1548", + "T1548.001" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + }, + "author": { + "name": "User Name", + "email": "email@microsoft.com" + }, + "support": { + "name": "Microsoft", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/", + "tier": "Partner" + }, + "dependencies": { + "operator": "AND", + "criteria": [ + { + "operator": "OR", + "criteria": [ + { + "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", + "kind": "DataConnector" + }, + { + "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", + "kind": "DataConnector" + }, + { + "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", + "kind": "DataConnector", + "version": "2.0" + } + ] + }, + { + "kind": "Playbook", + "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", + "version": "1.0" + }, + { + "kind": "Parser", + "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" + } + ] + }, + "categories": { + "domains": [ + "Application", + "Security – Insider Threat" + ], + "verticals": [ + "Healthcare" + ] + }, + "providers": [ + "Amazon", + "Microsoft" + ], + "firstPublishDate": "2021-05-18", + "lastPublishDate": "2021-05-18", + "previewImages": [ + "firstImage.png", + "secondImage.jpeg" + ], + "previewImagesDark": [ + "firstImageDark.png", + "secondImageDark.jpeg" + ], + "contentSchemaVersion": "2.0", + "customVersion": "1.0", + "threatAnalysisTactics": [ + "reconnaissance", + "commandandcontrol" + ], + "threatAnalysisTechniques": [ + "T1548", + "T1548.001" + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "version": "1.0.0.0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName", + "source": { + "kind": "Solution", + "name": "Contoso Solution 1.0", + "sourceId": "b688a130-76f4-4a07-bf57-762222a3cadf" + }, + "author": { + "name": "User Name", + "email": "email@microsoft.com" + }, + "support": { + "name": "Microsoft", + "email": "support@microsoft.com", + "link": "https://support.microsoft.com/", + "tier": "Partner" + }, + "dependencies": { + "operator": "AND", + "criteria": [ + { + "operator": "OR", + "criteria": [ + { + "contentId": "045d06d0-ee72-4794-aba4-cf5646e4c756", + "kind": "DataConnector" + }, + { + "contentId": "dbfcb2cc-d782-40ef-8d94-fe7af58a6f2d", + "kind": "DataConnector" + }, + { + "contentId": "de4dca9b-eb37-47d6-a56f-b8b06b261593", + "kind": "DataConnector", + "version": "2.0" + } + ] + }, + { + "kind": "Playbook", + "contentId": "31ee11cc-9989-4de8-b176-5e0ef5c4dbab", + "version": "1.0" + }, + { + "kind": "Parser", + "contentId": "21ba424a-9438-4444-953a-7059539a7a1b" + } + ] + }, + "categories": { + "domains": [ + "Application", + "Security – Insider Threat" + ], + "verticals": [ + "Healthcare" + ] + }, + "providers": [ + "Amazon", + "Microsoft" + ], + "firstPublishDate": "2021-05-18", + "lastPublishDate": "2021-05-18", + "previewImages": [ + "firstImage.png", + "secondImage.jpeg" + ], + "previewImagesDark": [ + "firstImageDark.png", + "secondImageDark.jpeg" + ], + "contentSchemaVersion": "2.0", + "customVersion": "1.0", + "threatAnalysisTactics": [ + "reconnaissance", + "commandandcontrol" + ], + "threatAnalysisTechniques": [ + "T1548", + "T1548.001" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PutMetadataMinimal.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PutMetadataMinimal.json new file mode 100644 index 000000000000..a0e4faf9eebb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/metadata/PutMetadataMinimal.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "metadataName": "metadataName", + "metadata": { + "properties": { + "contentId": "c00ee137-7475-47c8-9cce-ec6f0f1bedd0", + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/metadata/metadataName", + "name": "metadataName", + "type": "Microsoft.SecurityInsights/metadata", + "properties": { + "kind": "AnalyticsRule", + "parentId": "/subscriptions/2e1dc338-d04d-4443-b721-037eff4fdcac/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/ruleName" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/DeleteOfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/DeleteOfficeConsents.json new file mode 100644 index 000000000000..78c1861c87ea --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/DeleteOfficeConsents.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "consentId": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/GetOfficeConsents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/GetOfficeConsents.json new file mode 100644 index 000000000000..174afcd28933 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/GetOfficeConsents.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/officeConsents/04e5fd05-ff86-4b97-b8d2-1c20933cb46c", + "name": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c", + "type": "Microsoft.SecurityInsights/officeConsents", + "properties": { + "tenantId": "5460b3d2-1e7b-4757-ad54-c858c7e3f252", + "consentId": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/GetOfficeConsentsById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/GetOfficeConsentsById.json new file mode 100644 index 000000000000..fd6ca4f625aa --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/officeConsents/GetOfficeConsentsById.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "consentId": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/officeConsents/04e5fd05-ff86-4b97-b8d2-1c20933cb46c", + "name": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c", + "type": "Microsoft.SecurityInsights/officeConsents", + "properties": { + "tenantId": "5460b3d2-1e7b-4757-ad54-c858c7e3f252", + "consentId": "04e5fd05-ff86-4b97-b8d2-1c20933cb46c" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json new file mode 100644 index 000000000000..3078b0a72bf1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/CreateSentinelOnboardingState.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sentinelOnboardingStateName": "default", + "sentinelOnboardingStateParameter": { + "properties": { + "customerManagedKey": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default", + "name": "default", + "type": "Microsoft.SecurityInsights/onboardingStates", + "properties": { + "customerManagedKey": false + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default", + "name": "default", + "type": "Microsoft.SecurityInsights/onboardingStates", + "properties": { + "customerManagedKey": false + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json new file mode 100644 index 000000000000..f17bad1a2284 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/DeleteSentinelOnboardingState.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sentinelOnboardingStateName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json new file mode 100644 index 000000000000..dec5cb6389ca --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/GetAllSentinelOnboardingStates.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default", + "name": "default", + "type": "Microsoft.SecurityInsights/onboardingStates", + "properties": { + "customerManagedKey": false + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json new file mode 100644 index 000000000000..859b13e96239 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/onboardingStates/GetSentinelOnboardingState.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sentinelOnboardingStateName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/onboardingStates/default", + "name": "default", + "type": "Microsoft.SecurityInsights/onboardingStates", + "properties": { + "customerManagedKey": false + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/operations/ListOperations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/operations/ListOperations.json new file mode 100644 index 000000000000..aba7030e0252 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/operations/ListOperations.json @@ -0,0 +1,563 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SecurityInsights/operations/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Operations", + "operation": "Get Operations", + "description": "Gets operations" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/automationRules/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "AutomationRules", + "operation": "Get Automation Rules", + "description": "Gets an automation rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/automationRules/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "AutomationRules", + "operation": "Update Automation Rules", + "description": "Updates an automation rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/automationRules/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "AutomationRules", + "operation": "Delete Automation Rules", + "description": "Deletes an automation rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Bookmarks/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmarks", + "operation": "Get Bookmarks", + "description": "Gets bookmarks" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Bookmarks/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmarks", + "operation": "Update Bookmarks", + "description": "Updates bookmarks" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Bookmarks/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmarks", + "operation": "Delete Bookmarks", + "description": "Deletes bookmarks" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Bookmarks/expand/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmarks", + "operation": "Expand on entity", + "description": "Gets related entities of an entity by a specific expansion" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/bookmarks/relations/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmark Relations", + "operation": "Get Bookmark Relations", + "description": "Gets a bookmark relation" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/bookmarks/relations/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmark Relations", + "operation": "Update Bookmark Relations", + "description": "Updates a bookmark relation" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/bookmarks/relations/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Bookmark Relations", + "operation": "Delete Bookmark Relations", + "description": "Deletes a bookmark relation" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules", + "operation": "Get Alert Rules", + "description": "Gets the alert rules" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules", + "operation": "Update Alert Rules", + "description": "Updates alert rules" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules", + "operation": "Delete Alert Rules", + "description": "Deletes alert rules" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/actions/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules Actions", + "operation": "Get Alert Rule Response Actions", + "description": "Gets the response actions of an alert rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/actions/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules Actions", + "operation": "Update Alert Rule Response Actions", + "description": "Updates the response actions of an alert rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/alertRules/actions/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Alert Rules Actions", + "operation": "Delete Alert Rule Response Actions", + "description": "Deletes the response actions of an alert rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/dataConnectors/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "DataConnectors", + "operation": "Get Data Connectors", + "description": "Gets the data connectors" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/dataConnectors/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "DataConnectors", + "operation": "Update Data Connectors", + "description": "Updates a data connector" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/dataConnectors/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "DataConnectors", + "operation": "Delete a Data Connector", + "description": "Deletes a data connector" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/dataConnectorsCheckRequirements/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "DataConnectorsCheckRequirements", + "operation": "Check user authorization and license", + "description": "Check user authorization and license" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incidents", + "operation": "Get Incidents", + "description": "Gets an incident" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incidents", + "operation": "Update Incidents", + "description": "Updates an incident" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incidents", + "operation": "Delete Incidents", + "description": "Deletes an incident" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/comments/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Comments", + "operation": "Get Incident Comments", + "description": "Gets the incident comments" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/comments/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Comments", + "operation": "Create Incident Comments", + "description": "Creates a comment on the incident" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/comments/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Comments", + "operation": "Delete Incident Comment", + "description": "Deletes a comment on the incident" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/relations/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Relations", + "operation": "Get Incident Relations", + "description": "Gets a relation between the incident and related resources" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/relations/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Relations", + "operation": "Update Incident Relations", + "description": "Updates a relation between the incident and related resources" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/incidents/relations/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Incident Relations", + "operation": "Delete Incident Relations", + "description": "Deletes a relation between the incident and related resources" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Get Threat Intelligence", + "description": "Gets Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Update Threat Intelligence", + "description": "Updates Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Delete Threat Intelligence", + "description": "Deletes Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/query/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Query Threat Intelligence", + "description": "Query Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/metrics/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Collect Threat Intelligence Metrics", + "description": "Collect Threat Intelligence Metrics" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/bulkDelete/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Bulk Delete Threat Intelligence", + "description": "Bulk Delete Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/bulkTag/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Bulk Tags Threat Intelligence", + "description": "Bulk Tags Threat Intelligence" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Update Threat Intelligence Indicators", + "description": "Updates Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Delete Threat Intelligence Indicators", + "description": "Deletes Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/query/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Query Threat Intelligence Indicators", + "description": "Query Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/metrics/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Get Threat Intelligence Indicator Metrics", + "description": "Get Threat Intelligence Indicator Metrics" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/bulkDelete/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Bulk Delete Threat Intelligence Indicators", + "description": "Bulk Delete Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/bulkTag/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Bulk Tags Threat Intelligence Indicators", + "description": "Bulk Tags Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Get Threat Intelligence Indicators", + "description": "Gets Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/metrics/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Collect Threat Intelligence Metrics", + "description": "Collect Threat Intelligence Metrics" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/createIndicator/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Create Threat Intelligence Indicator", + "description": "Create Threat Intelligence Indicator" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/appendTags/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Append tags to Threat Intelligence Indicator", + "description": "Append tags to Threat Intelligence Indicator" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/indicators/replaceTags/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Replace Tags of Threat Intelligence Indicator", + "description": "Replace Tags of Threat Intelligence Indicator" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/threatintelligence/queryIndicators/action", + "display": { + "provider": "Microsoft Security Insights", + "resource": "ThreatIntelligence", + "operation": "Query Threat Intelligence Indicators", + "description": "Query Threat Intelligence Indicators" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Watchlists/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Watchlists", + "operation": "Get Watchlists", + "description": "Gets Watchlists" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Watchlists/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Watchlists", + "operation": "Create Watchlists", + "description": "Create Watchlists" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/Watchlists/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Watchlists", + "operation": "Delete Watchlists", + "description": "Deletes Watchlists" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/onboardingStates/read", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Onboarding States", + "operation": "Get Onboarding States", + "description": "Gets an onboarding state" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/onboardingStates/write", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Onboarding States", + "operation": "Update Onboarding States", + "description": "Updates an onboarding state" + }, + "origin": "user" + }, + { + "name": "Microsoft.SecurityInsights/onboardingStates/delete", + "display": { + "provider": "Microsoft Security Insights", + "resource": "Onboarding States", + "operation": "Delete Onboarding States", + "description": "Deletes an onboarding state" + }, + "origin": "user" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/GetRecommendation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/GetRecommendation.json new file mode 100644 index 000000000000..3ab83bfde2b1 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/GetRecommendation.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "recommendationId": "6d4b54eb-8684-4aa3-a156-3aa37b8014bc" + }, + "responses": { + "200": { + "body": { + "recommendationTypeId": "Swagger_Example", + "id": "6d4b54eb-8684-4aa3-a156-3aa37b8014bc", + "priority": "Medium", + "category": "Onboarding", + "context": "None", + "content": { + "title": "someText", + "description": "someText" + }, + "resourceId": "someId", + "recommendationTypeTitle": "someText", + "recommendationTypeDescription": "someText", + "instructions": { + "actionsToBePerformed": "someText", + "recommendationImportance": "someText" + }, + "additionalProperties": { + "someKey": "someValue" + }, + "title": "someText", + "description": "someText", + "workspaceId": "9a7711dc-40de-43b5-bf7e-ba25ec4592f3", + "actions": [ + { + "linkText": "someText", + "linkUrl": "https://www.someuri.com", + "state": "Active" + } + ], + "state": "CompletedByAction", + "hideUntilTimeUtc": "2022-02-19T03:09:03.4888396+00:00", + "displayUntilTimeUtc": "2022-02-19T03:57:31.7964447+00:00", + "lastEvaluatedTimeUtc": "2022-02-19T03:09:03.4888396+00:00" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/GetRecommendations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/GetRecommendations.json new file mode 100644 index 000000000000..3a47caabbbb5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/GetRecommendations.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "recommendationTypeId": "ThreatIntelligence_Example", + "id": "6d4b54eb-8684-4aa3-a156-3aa37b8014bc", + "priority": "Medium", + "category": "Onboarding", + "context": "None", + "content": { + "title": "someText", + "description": "someText" + }, + "resourceId": "someId", + "recommendationTypeTitle": "someText", + "recommendationTypeDescription": "someText", + "instructions": { + "actionsToBePerformed": "someText", + "recommendationImportance": "someText" + }, + "additionalProperties": { + "someKey": "someValue" + }, + "title": "someText", + "description": "someText", + "workspaceId": "9a7711dc-40de-43b5-bf7e-ba25ec4592f3", + "actions": [ + { + "linkText": "someText", + "linkUrl": "https://www.someuri.com", + "state": "Active" + } + ], + "state": "CompletedByAction", + "hideUntilTimeUtc": "2022-02-19T03:09:03.4888396+00:00", + "displayUntilTimeUtc": "2022-02-19T03:57:31.7964447+00:00", + "lastEvaluatedTimeUtc": "2022-02-19T03:09:03.4888396+00:00" + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/PatchRecommendation.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/PatchRecommendation.json new file mode 100644 index 000000000000..1a21368d6c58 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/recommendations/PatchRecommendation.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "recommendationId": "6d4b54eb-8684-4aa3-a156-3aa37b8014bc", + "recommendationPatch": [ + { + "state": "Active" + } + ] + }, + "responses": { + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SecurityInsights/recommendations/6d4b54eb-8684-4aa3-a156-3aa37b8014bc?api-version=2023-05-01-preview" + }, + "body": { + "recommendationTypeId": "ThreatIntelligence_Example", + "id": "6d4b54eb-8684-4aa3-a156-3aa37b8014bc", + "priority": "Medium", + "category": "Onboarding", + "context": "None", + "content": { + "title": "someText", + "description": "someText" + }, + "resourceId": "someId", + "recommendationTypeTitle": "someText", + "recommendationTypeDescription": "someText", + "instructions": { + "actionsToBePerformed": "someText", + "recommendationImportance": "someText" + }, + "additionalProperties": { + "someKey": "someValue" + }, + "title": "someText", + "description": "someText", + "workspaceId": "9a7711dc-40de-43b5-bf7e-ba25ec4592f3", + "actions": [ + { + "linkText": "someText", + "linkUrl": "https://www.someuri.com", + "state": "Active" + } + ], + "state": "CompletedByUser", + "hideUntilTimeUtc": "2022-02-19T03:09:03.4888396+00:00", + "displayUntilTimeUtc": "2022-02-19T03:57:31.7964447+00:00", + "lastEvaluatedTimeUtc": "2022-02-19T03:09:03.4888396+00:00" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/repositories/GetRepositories.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/repositories/GetRepositories.json new file mode 100644 index 000000000000..fe24d6ed6042 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/repositories/GetRepositories.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "repoType": "Github", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "url": "https://api.github.com/repos/user/reponame", + "fullName": "reponame", + "branches": [ + "master", + "develop" + ] + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json new file mode 100644 index 000000000000..4e467a631edd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/CreateAnomalySecurityMLAnalyticsSetting.json @@ -0,0 +1,245 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsResourceName": "f209187f-1d17-4431-94af-c141bf5f23db", + "securityMLAnalyticsSetting": { + "kind": "Anomaly", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "properties": { + "displayName": "Login from unusual region", + "description": "When account logs from a source region that has rarely been logged in from during the last 14 days, an anomaly is triggered.", + "enabled": true, + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "tactics": [ + "Exfiltration", + "CommandAndControl" + ], + "techniques": [ + "T1037", + "T1021" + ], + "anomalyVersion": "1.0.5", + "customizableObservations": { + "multiSelectObservations": null, + "singleSelectObservations": [ + { + "supportedValues": [ + "Palo Alto Networks", + "Fortinet", + "Check Point" + ], + "value": [ + "Palo Alto Networks" + ], + "supportedValuesKql": null, + "valuesKql": null, + "name": "Device vendor", + "description": "Select device vendor of network connection logs from CommonSecurityLog", + "sequenceNumber": 1, + "rerun": "RerunAlways" + } + ], + "prioritizeExcludeObservations": null, + "thresholdObservations": [ + { + "minimum": "1", + "maximum": "100", + "value": "25", + "name": "Daily data transfer threshold in MB", + "description": "Suppress anomalies when daily data transfered (in MB) per hour is less than the chosen value", + "sequenceNumber": 1, + "rerun": "RerunAlways" + }, + { + "minimum": "2", + "maximum": "10", + "value": "3", + "name": "Number of standard deviations", + "description": "Triggers anomalies when number of standard deviations is greater than the chosen value", + "sequenceNumber": 2, + "rerun": "RerunAlways" + } + ], + "singleValueObservations": null + }, + "frequency": "PT1H", + "settingsStatus": "Production", + "isDefaultSettings": true, + "anomalySettingsVersion": 0, + "settingsDefinitionId": "f209187f-1d17-4431-94af-c141bf5f23db" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/f209187f-1d17-4431-94af-c141bf5f23db", + "name": "f209187f-1d17-4431-94af-c141bf5f23db", + "etag": "\"01005144-0000-0d00-0000-6058632c0000\"", + "kind": "Anomaly", + "type": "Microsoft.SecurityInsights/securityMLAnalyticsSettings", + "properties": { + "displayName": "Login from unusual region", + "description": "When account logs from a source region that has rarely been logged in from during the last 14 days, an anomaly is triggered.", + "enabled": true, + "lastModifiedUtc": "2021-10-20T13:17:11.5340061Z", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "tactics": [ + "Exfiltration", + "CommandAndControl" + ], + "techniques": [ + "T1037", + "T1021" + ], + "anomalyVersion": "1.0.5", + "customizableObservations": { + "multiSelectObservations": null, + "singleSelectObservations": [ + { + "supportedValues": [ + "Palo Alto Networks", + "Fortinet", + "Check Point" + ], + "value": [ + "Palo Alto Networks" + ], + "supportedValuesKql": null, + "valuesKql": null, + "name": "Device vendor", + "description": "Select device vendor of network connection logs from CommonSecurityLog", + "sequenceNumber": 1, + "rerun": "RerunAlways" + } + ], + "prioritizeExcludeObservations": null, + "thresholdObservations": [ + { + "minimum": "1", + "maximum": "100", + "value": "25", + "name": "Daily data transfer threshold in MB", + "description": "Suppress anomalies when daily data transfered (in MB) per hour is less than the chosen value", + "sequenceNumber": 1, + "rerun": "RerunAlways" + }, + { + "minimum": "2", + "maximum": "10", + "value": "3", + "name": "Number of standard deviations", + "description": "Triggers anomalies when number of standard deviations is greater than the chosen value", + "sequenceNumber": 2, + "rerun": "RerunAlways" + } + ], + "singleValueObservations": null + }, + "frequency": "PT1H", + "settingsStatus": "Production", + "isDefaultSettings": true, + "anomalySettingsVersion": 0, + "settingsDefinitionId": "f209187f-1d17-4431-94af-c141bf5f23db" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/f209187f-1d17-4431-94af-c141bf5f23db", + "name": "f209187f-1d17-4431-94af-c141bf5f23db", + "etag": "\"01007444-0000-0d00-0000-605863a70000\"", + "kind": "Anomaly", + "type": "Microsoft.SecurityInsights/securityMLAnalyticsSettings", + "properties": { + "displayName": "Login from unusual region", + "description": "When account logs from a source region that has rarely been logged in from during the last 14 days, an anomaly is triggered.", + "enabled": true, + "lastModifiedUtc": "2021-10-20T13:17:11.5340061Z", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "tactics": [ + "Exfiltration", + "CommandAndControl" + ], + "techniques": [ + "T1037", + "T1021" + ], + "anomalyVersion": "1.0.5", + "customizableObservations": { + "multiSelectObservations": null, + "singleSelectObservations": [ + { + "supportedValues": [ + "Palo Alto Networks", + "Fortinet", + "Check Point" + ], + "value": [ + "Palo Alto Networks" + ], + "supportedValuesKql": null, + "valuesKql": null, + "name": "Device vendor", + "description": "Select device vendor of network connection logs from CommonSecurityLog", + "sequenceNumber": 1, + "rerun": "RerunAlways" + } + ], + "prioritizeExcludeObservations": null, + "thresholdObservations": [ + { + "minimum": "1", + "maximum": "100", + "value": "25", + "name": "Daily data transfer threshold in MB", + "description": "Suppress anomalies when daily data transfered (in MB) per hour is less than the chosen value", + "sequenceNumber": 1, + "rerun": "RerunAlways" + }, + { + "minimum": "2", + "maximum": "10", + "value": "3", + "name": "Number of standard deviations", + "description": "Triggers anomalies when number of standard deviations is greater than the chosen value", + "sequenceNumber": 2, + "rerun": "RerunAlways" + } + ], + "singleValueObservations": null + }, + "frequency": "PT1H", + "settingsStatus": "Production", + "isDefaultSettings": true, + "anomalySettingsVersion": 0, + "settingsDefinitionId": "f209187f-1d17-4431-94af-c141bf5f23db" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json new file mode 100644 index 000000000000..cd6e36ff164d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/DeleteSecurityMLAnalyticsSetting.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsResourceName": "f209187f-1d17-4431-94af-c141bf5f23db" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json new file mode 100644 index 000000000000..125209190e58 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/GetAllSecurityMLAnalyticsSettings.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/f209187f-1d17-4431-94af-c141bf5f23db", + "name": "f209187f-1d17-4431-94af-c141bf5f23db", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/securityMLAnalyticsSettings", + "kind": "Anomaly", + "properties": { + "displayName": "Login from unusual region", + "description": "When account logs from a source region that has rarely been logged in from during the last 14 days, an anomaly is triggered.", + "enabled": true, + "lastModifiedUtc": "2021-10-20T13:13:11.5340061Z", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "tactics": [ + "Exfiltration", + "CommandAndControl" + ], + "techniques": [ + "T1037", + "T1021" + ], + "anomalyVersion": "1.0.5", + "customizableObservations": { + "multiSelectObservations": null, + "singleSelectObservations": [ + { + "supportedValues": [ + "Palo Alto Networks", + "Fortinet", + "Check Point" + ], + "value": [ + "Palo Alto Networks" + ], + "supportedValuesKql": null, + "valuesKql": null, + "name": "Device vendor", + "description": "Select device vendor of network connection logs from CommonSecurityLog", + "sequenceNumber": 1, + "rerun": "RerunAlways" + } + ], + "prioritizeExcludeObservations": null, + "thresholdObservations": [ + { + "minimum": "1", + "maximum": "100", + "value": "25", + "name": "Daily data transfer threshold in MB", + "description": "Suppress anomalies when daily data transfered (in MB) per hour is less than the chosen value", + "sequenceNumber": 1, + "rerun": "RerunAlways" + }, + { + "minimum": "2", + "maximum": "10", + "value": "3", + "name": "Number of standard deviations", + "description": "Triggers anomalies when number of standard deviations is greater than the chosen value", + "sequenceNumber": 2, + "rerun": "RerunAlways" + } + ], + "singleValueObservations": null + }, + "frequency": "PT1H", + "settingsStatus": "Production", + "isDefaultSettings": true, + "anomalySettingsVersion": 0, + "settingsDefinitionId": "f209187f-1d17-4431-94af-c141bf5f23db" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json new file mode 100644 index 000000000000..adaaccb79f55 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/securityMLAnalyticsSettings/GetAnomalySecurityMLAnalyticsSetting.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsResourceName": "myFirstAnomalySettings" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/securityMLAnalyticsSettings/f209187f-1d17-4431-94af-c141bf5f23db", + "name": "f209187f-1d17-4431-94af-c141bf5f23db", + "etag": "\"260090e2-0000-0d00-0000-5d6fb8670000\"", + "type": "Microsoft.SecurityInsights/securityMLAnalyticsSettings", + "kind": "Anomaly", + "properties": { + "displayName": "Login from unusual region", + "description": "When account logs from a source region that has rarely been logged in from during the last 14 days, an anomaly is triggered.", + "enabled": true, + "lastModifiedUtc": "2021-10-20T13:13:11.5340061Z", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "tactics": [ + "Exfiltration", + "CommandAndControl" + ], + "techniques": [ + "T1037", + "T1021" + ], + "anomalyVersion": "1.0.5", + "customizableObservations": { + "multiSelectObservations": null, + "singleSelectObservations": [ + { + "supportedValues": [ + "Palo Alto Networks", + "Fortinet", + "Check Point" + ], + "value": [ + "Palo Alto Networks" + ], + "supportedValuesKql": null, + "valuesKql": null, + "name": "Device vendor", + "description": "Select device vendor of network connection logs from CommonSecurityLog", + "sequenceNumber": 1, + "rerun": "RerunAlways" + } + ], + "prioritizeExcludeObservations": null, + "thresholdObservations": [ + { + "minimum": "1", + "maximum": "100", + "value": "25", + "name": "Daily data transfer threshold in MB", + "description": "Suppress anomalies when daily data transfered (in MB) per hour is less than the chosen value", + "sequenceNumber": 1, + "rerun": "RerunAlways" + }, + { + "minimum": "2", + "maximum": "10", + "value": "3", + "name": "Number of standard deviations", + "description": "Triggers anomalies when number of standard deviations is greater than the chosen value", + "sequenceNumber": 2, + "rerun": "RerunAlways" + } + ], + "singleValueObservations": null + }, + "frequency": "PT1H", + "settingsStatus": "Production", + "isDefaultSettings": true, + "anomalySettingsVersion": 0, + "settingsDefinitionId": "f209187f-1d17-4431-94af-c141bf5f23db" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/DeleteEyesOnSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/DeleteEyesOnSetting.json new file mode 100644 index 000000000000..71096eeadb90 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/DeleteEyesOnSetting.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsName": "EyesOn" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/GetAllSettings.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/GetAllSettings.json new file mode 100644 index 000000000000..51c7dc5b4c56 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/GetAllSettings.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirInt/providers/Microsoft.SecurityInsights/settings/EyesOn", + "name": "EyesOn", + "type": "Microsoft.SecurityInsights/settings", + "kind": "EyesOn", + "properties": { + "isEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/GetEyesOnSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/GetEyesOnSetting.json new file mode 100644 index 000000000000..42ed5ec6a4b2 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/GetEyesOnSetting.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsName": "EyesOn" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirInt/providers/Microsoft.SecurityInsights/settings/EyesOn", + "name": "EyesOn", + "type": "Microsoft.SecurityInsights/settings", + "kind": "EyesOn", + "properties": { + "isEnabled": true + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/UpdateEyesOnSetting.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/UpdateEyesOnSetting.json new file mode 100644 index 000000000000..726b8fc7be39 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/settings/UpdateEyesOnSetting.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "settingsName": "EyesOn", + "settings": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "EyesOn", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/avdvirInt/providers/Microsoft.SecurityInsights/settings/EyesOn", + "name": "EyesOn", + "type": "Microsoft.SecurityInsights/settings", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "kind": "EyesOn", + "properties": { + "isEnabled": true + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/CreateSourceControl.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/CreateSourceControl.json new file mode 100644 index 000000000000..07a083165e97 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/CreateSourceControl.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "sourceControl": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My Source Control", + "description": "This is a source control", + "repoType": "Github", + "contentTypes": [ + "AnalyticRules", + "Workbook" + ], + "repository": { + "url": "https://github.com/user/repo", + "branch": "master", + "displayUrl": "https://github.com/user/repo", + "pathMapping": [ + { + "contentType": "AnalyticRules", + "path": "path/to/rules" + }, + { + "contentType": "Workbook", + "path": "path/to/workbooks" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "version": "V2", + "name": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "type": "Microsoft.SecurityInsights/SourceControls", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "displayName": "My Source Control", + "description": "this is a source control", + "repoType": "Github", + "contentTypes": [ + "AnalyticRules", + "Workbook" + ], + "repository": { + "url": "https://github.com/user/repo", + "branch": "master", + "displayUrl": "https://github.com/user/repo", + "deploymentLogsUrl": "https://github.com/user/repo/actions", + "pathMapping": [ + { + "contentType": "AnalyticRules", + "path": "path/to/rules" + }, + { + "contentType": "Workbook", + "path": "path/to/workbooks" + } + ] + }, + "repositoryResourceInfo": { + "webhook": { + "webhookId": "342768323", + "webhookUrl": "https://cac.sentinel.azure.com/workspaces/b7c525e9-1bfa-4435-88c0-817e13abb088/webhooks/ado/sourceControl/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "webhookSecretUpdateTime": "2021-01-01T17:18:19.1234567Z" + }, + "gitHubResourceInfo": { + "appInstallationId": "123" + }, + "azureDevOpsResourceInfo": null + }, + "lastDeploymentInfo": { + "deploymentFetchStatus": "Success", + "deployment": { + "deploymentId": "4985046420", + "deploymentState": "Completed", + "deploymentResult": "Success", + "deploymentTime": "2021-01-01T17:18:19.1234567Z", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "message": "Successful deployment" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "version": "V2", + "name": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "type": "Microsoft.SecurityInsights/SourceControls", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "displayName": "My Source Control", + "description": "this is a source control", + "repoType": "Github", + "contentTypes": [ + "AnalyticRules", + "Workbook" + ], + "repository": { + "url": "https://github.com/user/repo", + "branch": "master", + "displayUrl": "https://github.com/user/repo", + "deploymentLogsUrl": "https://github.com/user/repo/actions", + "pathMapping": [ + { + "contentType": "AnalyticRules", + "path": "path/to/rules" + }, + { + "contentType": "Workbook", + "path": "path/to/workbooks" + } + ] + }, + "repositoryResourceInfo": { + "webhook": { + "webhookId": "342768323", + "webhookUrl": "https://cac.sentinel.azure.com/workspaces/b7c525e9-1bfa-4435-88c0-817e13abb088/webhooks/ado/sourceControl/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "webhookSecretUpdateTime": "2021-01-01T17:18:19.1234567Z" + }, + "gitHubResourceInfo": { + "appInstallationId": "123" + }, + "azureDevOpsResourceInfo": null + }, + "lastDeploymentInfo": { + "deploymentFetchStatus": "Success", + "deployment": { + "deploymentId": "4985046420", + "deploymentState": "Completed", + "deploymentResult": "Success", + "deploymentTime": "2021-01-01T17:18:19.1234567Z", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "message": "Successful deployment" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/DeleteSourceControl.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/DeleteSourceControl.json new file mode 100644 index 000000000000..dc8b653813bd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/DeleteSourceControl.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/GetSourceControlById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/GetSourceControlById.json new file mode 100644 index 000000000000..be1f3d0b887d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/GetSourceControlById.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "sourceControlId": "789e0c1f-4a3d-43ad-809c-e713b677b04a" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "version": "V2", + "name": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "type": "Microsoft.SecurityInsights/SourceControls", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "displayName": "My Source Control", + "description": "this is a source control", + "repoType": "Github", + "contentTypes": [ + "AnalyticRules", + "Workbook" + ], + "repository": { + "url": "https://github.com/user/repo", + "branch": "master", + "displayUrl": "https://github.com/user/repo", + "deploymentLogsUrl": "https://github.com/user/repo/actions", + "pathMapping": [ + { + "contentType": "AnalyticRules", + "path": "path/to/rules" + }, + { + "contentType": "Workbook", + "path": "path/to/workbooks" + } + ] + }, + "repositoryResourceInfo": { + "webhook": { + "webhookId": "342768323", + "webhookUrl": "https://cac.sentinel.azure.com/workspaces/b7c525e9-1bfa-4435-88c0-817e13abb088/webhooks/ado/sourceControl/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "webhookSecretUpdateTime": "2021-01-01T17:18:19.1234567Z" + }, + "gitHubResourceInfo": { + "appInstallationId": "123" + }, + "azureDevOpsResourceInfo": null + }, + "lastDeploymentInfo": { + "deploymentFetchStatus": "Success", + "deployment": { + "deploymentId": "4985046420", + "deploymentState": "Completed", + "deploymentResult": "Success", + "deploymentTime": "2021-01-01T17:18:19.1234567Z", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "message": "Successful deployment" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/GetSourceControls.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/GetSourceControls.json new file mode 100644 index 000000000000..5fa06d54b50c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/sourcecontrols/GetSourceControls.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/sourcecontrols/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "version": "V2", + "name": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "type": "Microsoft.SecurityInsights/SourceControls", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "id": "789e0c1f-4a3d-43ad-809c-e713b677b04a", + "displayName": "My Source Control", + "description": "this is a source control", + "repoType": "Github", + "contentTypes": [ + "AnalyticRules", + "Workbook" + ], + "repository": { + "url": "https://github.com/user/repo", + "branch": "master", + "displayUrl": "https://github.com/user/repo", + "deploymentLogsUrl": "https://github.com/user/repo/actions", + "pathMapping": [ + { + "contentType": "AnalyticRules", + "path": "path/to/rules" + }, + { + "contentType": "Workbook", + "path": "path/to/workbooks" + } + ] + }, + "repositoryResourceInfo": { + "webhook": { + "webhookId": "342768323", + "webhookUrl": "https://cac.sentinel.azure.com/workspaces/b7c525e9-1bfa-4435-88c0-817e13abb088/webhooks/ado/sourceControl/789e0c1f-4a3d-43ad-809c-e713b677b04a", + "webhookSecretUpdateTime": "2021-01-01T17:18:19.1234567Z" + }, + "gitHubResourceInfo": { + "appInstallationId": "123" + }, + "azureDevOpsResourceInfo": null + }, + "lastDeploymentInfo": { + "deploymentFetchStatus": "Success", + "deployment": { + "deploymentId": "4985046420", + "deploymentState": "Completed", + "deploymentResult": "Success", + "deploymentTime": "2021-01-01T17:18:19.1234567Z", + "deploymentLogsUrl": "https://github.com/user/repo/actions" + }, + "message": "Successful deployment" + } + }, + "systemData": { + "createdBy": "user1", + "createdByType": "User", + "createdAt": "2021-01-01T17:18:19.1234567Z", + "lastModifiedBy": "user2", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-01-02T17:18:19.1234567Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json new file mode 100644 index 000000000000..e6ce5d35b439 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/AppendTagsThreatIntelligence.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceAppendTags": { + "threatIntelligenceTags": [ + "tag1", + "tag2" + ] + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json new file mode 100644 index 000000000000..78fd3784684b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/CollectThreatIntelligenceMetrics.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "lastUpdatedTimeUtc": "2021-09-01T19:44:44.117403Z", + "threatTypeMetrics": [ + { + "metricName": "compromised", + "metricValue": 20 + } + ], + "patternTypeMetrics": [ + { + "metricName": "url", + "metricValue": 20 + } + ], + "sourceMetrics": [ + { + "metricName": "Azure Sentinel", + "metricValue": 10315 + }, + { + "metricName": "zinga", + "metricValue": 2 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/CreateThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/CreateThreatIntelligence.json new file mode 100644 index 000000000000..c9fdad33ca79 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/CreateThreatIntelligence.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ThreatIntelligenceProperties": { + "kind": "indicator", + "properties": { + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "confidence": 78, + "createdByRef": "contoso@contoso.com", + "description": "debugging indicators", + "externalReferences": [], + "granularMarkings": [], + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "labels": [], + "modified": "", + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "revoked": false, + "validFrom": "2021-09-15T17:44:00.114052Z", + "validUntil": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-09-15T20:20:38.6160949Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-09-15T17:44:00.114052Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-09-15T20:20:38.6160949Z", + "createdByRef": "aztestConnectors@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-09-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-09-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json new file mode 100644 index 000000000000..ebea5f5805ee --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/DeleteThreatIntelligence.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/GetThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/GetThreatIntelligence.json new file mode 100644 index 000000000000..9b81efb1d7d5 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/GetThreatIntelligence.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "name": "27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "etag": "\"00002f2c-0000-0800-0000-5e976a8e0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 90, + "created": "2021-04-15T20:11:57.9666134Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--8516d567-0daa-4614-8745-e3591e1b48cf", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T20:15:11.0746926Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema 2", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + }, + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T19:51:17.1050923Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T20:15:11.074903Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json new file mode 100644 index 000000000000..dab25e010d55 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/GetThreatIntelligenceById.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T19:51:17.1050923Z", + "createdByRef": "aztestConnectors@dataconnector.ccsctp.net", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T20:18:49.2259902Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://abc.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/QueryThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/QueryThreatIntelligence.json new file mode 100644 index 000000000000..f0a1ecc3eb1a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/QueryThreatIntelligence.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ThreatIntelligenceFilteringCriteria": { + "pageSize": 100, + "minConfidence": 25, + "maxConfidence": 80, + "minValidUntil": "2021-04-05T17:44:00.114052Z", + "maxValidUntil": "2021-04-25T17:44:00.114052Z", + "sources": [ + "Azure Sentinel" + ], + "sortBy": [ + { + "itemKey": "lastUpdatedTimeUtc", + "sortOrder": "descending" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "name": "27d963e6-e6e4-e0f9-e9d7-c53985b3bbe8", + "etag": "\"00002f2c-0000-0800-0000-5e976a8e0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 90, + "created": "2021-04-15T20:11:57.9666134Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--8516d567-0daa-4614-8745-e3591e1b48cf", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:15:11.0746926Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema 2", + "description": "debugging indicators 2", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z", + "parsedPattern": [ + { + "patternTypeKey": "network-traffic", + "patternTypeValues": [ + { + "valueType": "0", + "value": "SSH-2.0-PuTTY_Release_0.64" + }, + { + "valueType": "1", + "value": "194.88.106.146" + } + ] + } + ] + } + }, + { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T19:51:17.1050923Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T20:15:11.074903Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json new file mode 100644 index 000000000000..e12851a33194 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/ReplaceTagsThreatIntelligence.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceReplaceTags": { + "etag": "\"0000262c-0000-0800-0000-5e9767060000\"", + "kind": "indicator", + "properties": { + "threatIntelligenceTags": [ + "patching tags" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "name": "e16ef847-962e-d7b6-9c8b-a33e4bd30e47", + "etag": "\"00002a2c-0000-0800-0000-5e97683b0000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T19:51:17.1050923Z", + "createdByRef": "aztestConnectors@dataconnector.ccsctp.net", + "externalId": "indicator--73be1729-babb-4348-a6c4-94621cae2530", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T19:56:08.828946Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "patching tags" + ], + "displayName": "updated indicator", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://abc.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json new file mode 100644 index 000000000000..320ecae253ff --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/threatintelligence/UpdateThreatIntelligence.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "bd794837-4d29-4647-9105-6339bfdb4e6a", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "name": "d9cd6f0b-96b9-3984-17cd-a779d1e15a93", + "ThreatIntelligenceProperties": { + "kind": "indicator", + "properties": { + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "confidence": 78, + "createdByRef": "contoso@contoso.com", + "description": "debugging indicators", + "externalReferences": [], + "granularMarkings": [], + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "labels": [], + "modified": "", + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "revoked": false, + "validFrom": "2020-04-15T17:44:00.114052Z", + "validUntil": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T20:20:38.6160949Z", + "createdByRef": "contoso@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2020-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/bd794837-4d29-4647-9105-6339bfdb4e6a/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/ThreatIntelligence/180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "name": "180105c7-a28d-b1a2-4a78-234f6ec80fd6", + "etag": "\"0000322c-0000-0800-0000-5e976c960000\"", + "type": "Microsoft.SecurityInsights/ThreatIntelligence", + "kind": "indicator", + "properties": { + "confidence": 78, + "created": "2021-04-15T20:20:38.6160949Z", + "createdByRef": "aztestConnectors@contoso.com", + "externalId": "indicator--a2b6a95e-2108-4a38-bd49-ef95811bbcd7", + "externalReferences": [], + "granularMarkings": [], + "lastUpdatedTimeUtc": "2021-04-15T20:20:38.6161887Z", + "revoked": false, + "source": "Azure Sentinel", + "threatIntelligenceTags": [ + "new schema" + ], + "displayName": "new schema", + "description": "debugging indicators", + "threatTypes": [ + "compromised" + ], + "killChainPhases": [], + "pattern": "[url:value = 'https://www.contoso.com']", + "patternType": "url", + "validFrom": "2021-04-15T17:44:00.114052Z" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json new file mode 100644 index 000000000000..a7f70a94d74b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggerRuleRun_Post.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleId": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "analyticsRuleRunTriggerParameter": { + "properties": { + "executionTimeUtc": "2022-12-22T15:37:03.074Z" + } + } + }, + "responses": { + "202": { + "headers": { + "Code": "202", + "Message": "Accepted", + "Location": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns/5abbc58b-9655-4f9b-80ac-5a576753e4ec?api-version=2023-05-01-preview" + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json new file mode 100644 index 000000000000..97fba9cec986 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRun_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "ruleRunId": "65360bb0-8986-4ade-a89d-af3cf44d28aa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns/65360bb0-8986-4ade-a89d-af3cf44d28aa", + "name": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "type": "Microsoft.SecurityInsights/TriggeredAnalyticsRuleRuns", + "properties": { + "executionTimeUtc": "2022-12-22T15:37:03.074Z", + "ruleId": "358e16da-ab76-4027-89e1-15937a6ed401", + "triggeredAnalyticsRuleRunId": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "provisioningState": "InProgress", + "ruleRunAdditionalData": { + "auditCorrelationId": "b8540a76-cb05-4a9b-8d52-9959b509e4ad", + "createdBy": "user@microsoft.com", + "healthCorrelationId": "dadd8fdc-fc7a-4005-a289-4e164cb75093" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json new file mode 100644 index 000000000000..dba75a48023a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/triggeredAnalyticsRuleRuns/triggeredAnalyticsRuleRuns_Get.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns/65360bb0-8986-4ade-a89d-af3cf44d28aa", + "name": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "type": "Microsoft.SecurityInsights/TriggeredAnalyticsRuleRuns", + "properties": { + "executionTimeUtc": "2022-12-22T15:37:03.074Z", + "ruleId": "358e16da-ab76-4027-89e1-15937a6ed401", + "triggeredAnalyticsRuleRunId": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "provisioningState": "InProgress", + "ruleRunAdditionalData": { + "auditCorrelationId": "b8540a76-cb05-4a9b-8d52-9959b509e4ad", + "createdBy": "user@microsoft.com", + "healthCorrelationId": "dadd8fdc-fc7a-4005-a289-4e164cb75093" + } + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/triggeredAnalyticsRuleRuns/1f62ea0f-2d25-4b65-bd4d-bb9114bcbd9c", + "name": "1f62ea0f-2d25-4b65-bd4d-bb9114bcbd9c", + "type": "Microsoft.SecurityInsights/TriggeredAnalyticsRuleRuns", + "properties": { + "executionTimeUtc": "2022-12-20T15:37:03.074Z", + "ruleId": "358e16da-ab76-4027-89e1-15937a6ed401", + "triggeredAnalyticsRuleRunId": "1f62ea0f-2d25-4b65-bd4d-bb9114bcbd9c", + "provisioningState": "Succeeded", + "ruleRunAdditionalData": { + "auditCorrelationId": "763f9dae-1027-44b9-a34a-589404693670", + "createdBy": "user2@microsoft.com", + "healthCorrelationId": "b3c165ec-f53e-48c1-9677-216d9e930912" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlist.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlist.json new file mode 100644 index 000000000000..b672d104d4bc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlist.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "watchlistAlias": "highValueAsset", + "watchlist": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "High Value Assets Watchlist", + "source": "watchlist.csv", + "sourceType": "Local file", + "provider": "Microsoft", + "description": "Watchlist from CSV content", + "itemsSearchKey": "header1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json new file mode 100644 index 000000000000..3ff4b812c19a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlistAndWatchlistItems.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlist": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "High Value Assets Watchlist", + "source": "watchlist.csv", + "sourceType": "Local file", + "provider": "Microsoft", + "description": "Watchlist from CSV content", + "numberOfLinesToSkip": 1, + "rawContent": "This line will be skipped\nheader1,header2\nvalue1,value2", + "itemsSearchKey": "header1", + "contentType": "text/csv" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "type": "Microsoft.SecurityInsights/Watchlists", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlistItem.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlistItem.json new file mode 100644 index 000000000000..cb1b3e21488d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/CreateWatchlistItem.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842", + "watchlistItem": { + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "properties": { + "itemsKeyValue": { + "Gateway subnet": "10.0.255.224/27", + "Web Tier": "10.0.1.0/24", + "Business tier": "10.0.2.0/24", + "Data tier": "10.0.2.0/24", + "Private DMZ in": "10.0.0.0/27", + "Public DMZ out": "10.0.0.96/27" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/82ba292c-dc97-4dfc-969d-d4dd9e666842", + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842", + "tenantId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea", + "isDeleted": false, + "created": "2020-11-15T04:58:56.0748363+00:00", + "updated": "2020-11-16T16:05:20+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "itemsKeyValue": { + "Gateway subnet": "10.0.255.224/27", + "Web Tier": "10.0.1.0/24", + "Business tier": "10.0.2.0/24", + "Data tier": "10.0.2.0/24", + "Private DMZ in": "10.0.0.0/27", + "Public DMZ out": "10.0.0.96/27" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/82ba292c-dc97-4dfc-969d-d4dd9e666842", + "etag": "0300bf09-0000-0000-0000-5c37296e0000", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "82ba292c-dc97-4dfc-969d-d4dd9e666842", + "tenantId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea", + "isDeleted": false, + "created": "2020-11-15T04:58:56.0748363+00:00", + "updated": "2020-11-16T16:05:20+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "itemsKeyValue": { + "Gateway subnet": "10.0.255.224/27", + "Web Tier": "10.0.1.0/24", + "Business tier": "10.0.2.0/24", + "Data tier": "10.0.2.0/24", + "Private DMZ in": "10.0.0.0/27", + "Public DMZ out": "10.0.0.96/27" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/DeleteWatchlist.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/DeleteWatchlist.json new file mode 100644 index 000000000000..f00c759439c0 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/DeleteWatchlist.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset" + }, + "responses": { + "200": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SecurityInsights/watchlists/1011-01/watchlistStatuses/00000000-0000-0000-0000-000000000000?api-version=2023-05-01-preview" + } + }, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/DeleteWatchlistItem.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/DeleteWatchlistItem.json new file mode 100644 index 000000000000..fca6684e174a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/DeleteWatchlistItem.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlistItemId": "4008512e-1d30-48b2-9ee2-d3612ed9d3ea" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistByAlias.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistByAlias.json new file mode 100644 index 000000000000..48729952f2bb --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistByAlias.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "type": "Microsoft.SecurityInsights/Watchlists", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "labels": [ + "Tag1", + "Tag2" + ], + "defaultDuration": "P1279DT12H30M5S", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistItemById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistItemById.json new file mode 100644 index 000000000000..22690acb1e7e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistItemById.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset", + "watchlistItemId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/fd37d325-7090-47fe-851a-5b5a00c3f576", + "name": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "etag": "\"f2089bfa-0000-0d00-0000-601c58b42021\"", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "tenantId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797", + "isDeleted": false, + "created": "2021-02-04T12:27:32.3783333-08:00", + "updated": "2021-02-04T12:27:32.3783333-08:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "itemsKeyValue": { + "Header-1": "v1_1", + "Header-2": "v1_2", + "Header-3": "v1_3", + "Header-4": "v1_4", + "Header-5": "v1_5" + }, + "entityMapping": {} + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistItems.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistItems.json new file mode 100644 index 000000000000..a1b4e3df22be --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlistItems.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "watchlistAlias": "highValueAsset" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/Watchlists/highValueAsset/WatchlistItems/fd37d325-7090-47fe-851a-5b5a00c3f576", + "name": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "etag": "\"f2089bfa-0000-0d00-0000-601c58b42021\"", + "type": "Microsoft.SecurityInsights/Watchlists/WatchlistItems", + "properties": { + "watchlistItemType": "watchlist-item", + "watchlistItemId": "fd37d325-7090-47fe-851a-5b5a00c3f576", + "tenantId": "3f8901fe-63d9-4875-9ad5-9fb3b8105797", + "isDeleted": false, + "created": "2021-02-04T12:27:32.3783333-08:00", + "updated": "2021-02-04T12:27:32.3783333-08:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "itemsKeyValue": { + "Header-1": "v1_1", + "Header-2": "v1_2", + "Header-3": "v1_3", + "Header-4": "v1_4", + "Header-5": "v1_5" + }, + "entityMapping": {} + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlists.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlists.json new file mode 100644 index 000000000000..0551b1060fbe --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/watchlists/GetWatchlists.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/watchlists/highValueAsset", + "name": "highValueAsset", + "type": "Microsoft.SecurityInsights/Watchlists", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "watchlistId": "76d5a51f-ba1f-4038-9d22-59fda38dc017", + "displayName": "High Value Assets Watchlist", + "provider": "Microsoft", + "source": "watchlist.csv", + "sourceType": "Local file", + "created": "2020-09-28T00:26:54.7746089+00:00", + "updated": "2020-09-28T00:26:57+00:00", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "description": "Watchlist from CSV content", + "watchlistType": "watchlist", + "watchlistAlias": "highValueAsset", + "itemsSearchKey": "header1", + "isDeleted": false, + "labels": [ + "Tag1", + "Tag2" + ], + "defaultDuration": "P1279DT12H30M5S", + "tenantId": "f686d426-8d16-42db-81b7-ab578e110ccd" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/CreateJob.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/CreateJob.json new file mode 100644 index 000000000000..def97f140083 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/CreateJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "jobName": "cfbe1338-8276-4d5d-8b96-931117f9fa0e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58/jobs/cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "etag": "\"f20a2523-7817-47b5-a3b2-21539c00c788\"", + "name": "cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments/jobs", + "properties": { + "startTime": "2022-06-14T04:47:52.9614956Z", + "provisioningState": "InProgress" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json new file mode 100644 index 000000000000..1bf06a531395 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/CreateOrUpdateWorkspaceManagerAssignment.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "workspaceManagerAssignment": { + "properties": { + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo" + } + ], + "targetResourceName": "37207a7a-3b8a-438f-a559-c7df400e1b96" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments", + "properties": { + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo" + } + ], + "targetResourceName": "37207a7a-3b8a-438f-a559-c7df400e1b96" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments", + "properties": { + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo" + } + ], + "targetResourceName": "37207a7a-3b8a-438f-a559-c7df400e1b96" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/DeleteJob.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/DeleteJob.json new file mode 100644 index 000000000000..38a230344a72 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/DeleteJob.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "jobName": "cfbe1338-8276-4d5d-8b96-931117f9fa0e" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json new file mode 100644 index 000000000000..635c5d15d52a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/DeleteWorkspaceManagerAssignment.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json new file mode 100644 index 000000000000..9012e53251cc --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetAllJobs.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58/jobs/cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "etag": "\"f20a2523-7817-47b5-a3b2-21539c00c788\"", + "name": "cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments/jobs", + "properties": { + "endTime": "2022-06-14T04:52:52.9614956Z", + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne", + "status": "Succeeded", + "executionTime": "2022-06-14T04:49:52.9614956Z" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo", + "status": "Failed", + "executionTime": "2022-06-14T04:50:52.9614956Z", + "errors": [ + { + "memberResourceName": "f5fa104e-c0e3-4747-9182-d342dc048a9e", + "errorMessage": "Failed to write. Status code: Forbidden." + } + ] + } + ], + "startTime": "2022-06-14T04:47:52.9614956Z", + "provisioningState": "Failed" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json new file mode 100644 index 000000000000..5c424603b477 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetAllWorkspaceManagerAssignments.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments", + "properties": { + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo" + } + ], + "targetResourceName": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "lastJobEndTime": "2022-06-14T04:52:52.9614956Z", + "lastJobProvisioningState": "Failed" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetJob.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetJob.json new file mode 100644 index 000000000000..2dc6a8be8089 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetJob.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "jobName": "cfbe1338-8276-4d5d-8b96-931117f9fa0e" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58/jobs/cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "etag": "\"f20a2523-7817-47b5-a3b2-21539c00c788\"", + "name": "cfbe1338-8276-4d5d-8b96-931117f9fa0e", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments/jobs", + "properties": { + "endTime": "2022-06-14T04:52:52.9614956Z", + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne", + "status": "Succeeded", + "executionTime": "2022-06-14T04:49:52.9614956Z" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo", + "status": "Failed", + "executionTime": "2022-06-14T04:50:52.9614956Z", + "errors": [ + { + "memberResourceName": "f5fa104e-c0e3-4747-9182-d342dc048a9e", + "errorMessage": "Failed to write. Status code: Forbidden." + } + ] + } + ], + "startTime": "2022-06-14T04:47:52.9614956Z", + "provisioningState": "Failed" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json new file mode 100644 index 000000000000..8828a969e8ce --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerAssignments/GetWorkspaceManagerAssignment.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerAssignmentName": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerAssignments/47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "47cdc5f5-37c4-47b5-bd5f-83c84b8bdd58", + "type": "Microsoft.SecurityInsights/workspaceManagerAssignments", + "properties": { + "items": [ + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleOne" + }, + { + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspac-es/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/microsoftSecurityIncidentCreationRuleExampleTwo" + } + ], + "targetResourceName": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "lastJobEndTime": "2022-06-14T04:52:52.9614956Z", + "lastJobProvisioningState": "Failed" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json new file mode 100644 index 000000000000..e788a059f448 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/CreateOrUpdateWorkspaceManagerConfiguration.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerConfigurationName": "default", + "workspaceManagerConfiguration": { + "properties": { + "mode": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "default", + "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations", + "properties": { + "mode": "Enabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "default", + "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations", + "properties": { + "mode": "Enabled" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json new file mode 100644 index 000000000000..de94d13dc44c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/DeleteWorkspaceManagerConfiguration.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerConfigurationName": "default" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json new file mode 100644 index 000000000000..452eb292654d --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/GetAllWorkspaceManagerConfigurations.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "default", + "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations", + "properties": { + "mode": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json new file mode 100644 index 000000000000..d64cd6ae70ed --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerConfigurations/GetWorkspaceManagerConfiguration.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerConfigurationName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerConfigurations/default", + "etag": "\"3f6451dd-1b58-4bef-bce7-72eba6b354d7\"", + "name": "default", + "type": "Microsoft.SecurityInsights/workspaceManagerConfigurations", + "properties": { + "mode": "Enabled" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json new file mode 100644 index 000000000000..725302d1069f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/CreateOrUpdateWorkspaceManagerGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerGroupName": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "workspaceManagerGroup": { + "properties": { + "description": "Group of all financial and banking institutions", + "displayName": "Banks", + "memberResourceNames": [ + "afbd324f-6c48-459c-8710-8d1e1cd03812", + "f5fa104e-c0e3-4747-9182-d342dc048a9e" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerGroups/37207a7a-3b8a-438f-a559-c7df400e1b96", + "etag": "\"ac04c9ad-4b3c-4e13-b511-8c2225e46521\"", + "name": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "type": "Microsoft.SecurityInsights/workspaceManagerGroups", + "properties": { + "description": "Group of all financial and banking institutions", + "displayName": "Banks", + "memberResourceNames": [ + "afbd324f-6c48-459c-8710-8d1e1cd03812", + "f5fa104e-c0e3-4747-9182-d342dc048a9e" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerGroups/37207a7a-3b8a-438f-a559-c7df400e1b96", + "etag": "\"ac04c9ad-4b3c-4e13-b511-8c2225e46521\"", + "name": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "type": "Microsoft.SecurityInsights/workspaceManagerGroups", + "properties": { + "description": "Group of all financial and banking institutions", + "displayName": "Banks", + "memberResourceNames": [ + "afbd324f-6c48-459c-8710-8d1e1cd03812", + "f5fa104e-c0e3-4747-9182-d342dc048a9e" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json new file mode 100644 index 000000000000..2fc56eedcd24 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/DeleteWorkspaceManagerGroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerGroupName": "37207a7a-3b8a-438f-a559-c7df400e1b96" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json new file mode 100644 index 000000000000..f2d35b3d19aa --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/GetAllWorkspaceManagerGroups.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerGroups/37207a7a-3b8a-438f-a559-c7df400e1b96", + "etag": "\"ac04c9ad-4b3c-4e13-b511-8c2225e46521\"", + "name": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "type": "Microsoft.SecurityInsights/workspaceManagerGroups", + "properties": { + "description": "Group of all financial and banking institutions", + "displayName": "Banks", + "memberResourceNames": [ + "afbd324f-6c48-459c-8710-8d1e1cd03812", + "f5fa104e-c0e3-4747-9182-d342dc048a9e" + ] + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json new file mode 100644 index 000000000000..80edc1a0a8e3 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerGroups/GetWorkspaceManagerGroup.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerGroupName": "37207a7a-3b8a-438f-a559-c7df400e1b96" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerGroups/37207a7a-3b8a-438f-a559-c7df400e1b96", + "etag": "\"ac04c9ad-4b3c-4e13-b511-8c2225e46521\"", + "name": "37207a7a-3b8a-438f-a559-c7df400e1b96", + "type": "Microsoft.SecurityInsights/workspaceManagerGroups", + "properties": { + "description": "Group of all financial and banking institutions", + "displayName": "Banks", + "memberResourceNames": [ + "afbd324f-6c48-459c-8710-8d1e1cd03812", + "f5fa104e-c0e3-4747-9182-d342dc048a9e" + ] + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json new file mode 100644 index 000000000000..b07a333af093 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/CreateOrUpdateWorkspaceManagerMember.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerMemberName": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "workspaceManagerMember": { + "properties": { + "targetWorkspaceId": "/subscriptions/7aef9d48-814f-45ad-b644-b0343316e174/resourceGroups/otherRg/providers/Microsoft.OperationalInsights/workspaces/Example_Workspace", + "targetWorkspaceTenantId": "f676d436-8d16-42db-81b7-ab578e110ccd" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerMembers/afbd324f-6c48-459c-8710-8d1e1cd03812", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/workspaceManagerMembers", + "properties": { + "targetWorkspaceId": "/subscriptions/7aef9d48-814f-45ad-b644-b0343316e174/resourceGroups/otherRg/providers/Microsoft.OperationalInsights/workspaces/Example_Workspace", + "targetWorkspaceTenantId": "f676d436-8d16-42db-81b7-ab578e110ccd" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerMembers/afbd324f-6c48-459c-8710-8d1e1cd03812", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/workspaceManagerMembers", + "properties": { + "targetWorkspaceId": "/subscriptions/7aef9d48-814f-45ad-b644-b0343316e174/resourceGroups/otherRg/providers/Microsoft.OperationalInsights/workspaces/Example_Workspace", + "targetWorkspaceTenantId": "f676d436-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json new file mode 100644 index 000000000000..43a166eb3e9e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/DeleteWorkspaceManagerMember.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerMemberName": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json new file mode 100644 index 000000000000..65ea1bab620b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/GetAllWorkspaceManagerMembers.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerMembers/afbd324f-6c48-459c-8710-8d1e1cd03812", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/workspaceManagerMembers", + "properties": { + "targetWorkspaceId": "/subscriptions/7aef9d48-814f-45ad-b644-b0343316e174/resourceGroups/otherRg/providers/Microsoft.OperationalInsights/workspaces/Example_Workspace", + "targetWorkspaceTenantId": "f676d436-8d16-42db-81b7-ab578e110ccd" + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json new file mode 100644 index 000000000000..dae4869e4d49 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/examples/workspaceManagerMembers/GetWorkspaceManagerMember.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2023-05-01-preview", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "workspaceManagerMemberName": "afbd324f-6c48-459c-8710-8d1e1cd03812" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalInsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/workspaceManagerMembers/afbd324f-6c48-459c-8710-8d1e1cd03812", + "etag": "\"190057d0-0000-0d00-0000-5c6f5adb0000\"", + "name": "afbd324f-6c48-459c-8710-8d1e1cd03812", + "type": "Microsoft.SecurityInsights/workspaceManagerMembers", + "properties": { + "targetWorkspaceId": "/subscriptions/7aef9d48-814f-45ad-b644-b0343316e174/resourceGroups/otherRg/providers/Microsoft.OperationalInsights/workspaces/Example_Workspace", + "targetWorkspaceTenantId": "f676d436-8d16-42db-81b7-ab578e110ccd" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/operations.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/operations.json new file mode 100644 index 000000000000..5ff295968b2b --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2023-05-01-preview/operations.json @@ -0,0 +1,138 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Insights", + "description": "API spec for Microsoft.SecurityInsights (Azure Security Insights) resource provider", + "version": "2023-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": { + "/providers/Microsoft.SecurityInsights/operations": { + "get": { + "x-ms-examples": { + "Get all operations.": { + "$ref": "./examples/operations/ListOperations.json" + } + }, + "operationId": "Operations_List", + "description": "Lists all operations available Azure Security Insights Resource Provider.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "OK. Successfully retrieved operations list.", + "schema": { + "$ref": "#/definitions/OperationsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/2.0/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationsList": { + "description": "Lists the operations available in the SecurityInsights RP.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of operations.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Array of operations", + "items": { + "$ref": "#/definitions/Operation" + }, + "type": "array" + } + }, + "required": [ + "value" + ], + "type": "object" + }, + "Operation": { + "description": "Operation provided by provider", + "properties": { + "display": { + "description": "Properties of the operation", + "properties": { + "description": { + "description": "Description of the operation", + "type": "string" + }, + "operation": { + "description": "Operation name", + "type": "string" + }, + "provider": { + "description": "Provider name", + "type": "string" + }, + "resource": { + "description": "Resource name", + "type": "string" + } + }, + "type": "object" + }, + "name": { + "description": "Name of the operation", + "type": "string" + }, + "origin": { + "description": "The origin of the operation", + "type": "string" + }, + "isDataAction": { + "description": "Indicates whether the operation is a data action", + "type": "boolean" + } + }, + "type": "object" + } + }, + "parameters": {} +} diff --git a/specification/securityinsights/resource-manager/readme.md b/specification/securityinsights/resource-manager/readme.md index 0d06f21768ff..072ce90d5574 100644 --- a/specification/securityinsights/resource-manager/readme.md +++ b/specification/securityinsights/resource-manager/readme.md @@ -26,18 +26,55 @@ These are the global settings for the SecurityInsights API. ``` yaml openapi-type: arm -tag: package-preview-2023-04 +tag: package-preview-2023-05 ``` - --- +### Tag: package-preview-2023-05 + +These settings apply only when `--tag=package-preview-2023-05` is specified on the command line. + +```yaml $(tag) == 'package-preview-2023-05' +input-file: + - Microsoft.SecurityInsights/preview/2023-05-01-preview/AlertRules.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/AutomationRules.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/BillingStatistics.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/Bookmarks.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentPackages.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentProductPackages.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentProductTemplates.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/ContentTemplates.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/Enrichment.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/Entities.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/EntityQueries.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/EntityQueryTemplates.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/FileImports.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/Hunts.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/Incidents.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/Metadata.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/OfficeConsents.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/OnboardingStates.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/Recommendations.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/SecurityMLAnalyticsSettings.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/Settings.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/SourceControls.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/ThreatIntelligence.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/TriggeredAnalyticsRuleRuns.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/Watchlists.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerAssignments.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerConfigurations.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerGroups.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/WorkspaceManagerMembers.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/dataConnectors.json + - Microsoft.SecurityInsights/preview/2023-05-01-preview/operations.json +``` ### Tag: package-preview-2023-04 These settings apply only when `--tag=package-preview-2023-04` is specified on the command line. -```yaml $(tag) == 'package-preview-2023-04' +``` yaml $(tag) == 'package-preview-2023-04' input-file: - Microsoft.SecurityInsights/preview/2023-04-01-preview/AlertRules.json - Microsoft.SecurityInsights/preview/2023-04-01-preview/AutomationRules.json @@ -70,6 +107,7 @@ input-file: - Microsoft.SecurityInsights/preview/2023-04-01-preview/dataConnectors.json - Microsoft.SecurityInsights/preview/2023-04-01-preview/operations.json ``` + ### Tag: package-preview-2023-03 These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. From e6c0e188a74d051a3a44728ce058e85447553392 Mon Sep 17 00:00:00 2001 From: Dapeng Zhang Date: Thu, 11 May 2023 16:49:41 +0800 Subject: [PATCH 61/79] Revert "[Hub Generated] Publish private branch 'dev-maintenance-Microsoft.Maintenance-2023-04-01' (#23832)" (#23923) This reverts commit 3ce676c2fc2338288452c140f2f9d65e61018e8f. --- .../stable/2023-04-01/Maintenance.json | 3040 ----------------- .../ApplyUpdatesResourceGroup_List.json | 25 - .../examples/ApplyUpdates_CreateOrUpdate.json | 34 - .../ApplyUpdates_CreateOrUpdateParent.json | 36 - .../2023-04-01/examples/ApplyUpdates_Get.json | 24 - .../examples/ApplyUpdates_GetParent.json | 26 - .../examples/ApplyUpdates_List.json | 24 - ...nmentsForResourceGroup_CreateOrUpdate.json | 116 - ...ionAssignmentsForResourceGroup_Delete.json | 19 - ...rationAssignmentsForResourceGroup_Get.json | 46 - ...ntsForResourceGroup_UpdateForResource.json | 76 - ...nmentsForSubscriptions_CreateOrUpdate.json | 123 - ...ionAssignmentsForSubscriptions_Delete.json | 18 - ...rationAssignmentsForSubscriptions_Get.json | 45 - ...ntsForSubscriptions_UpdateForResource.json | 83 - ...ignmentsResultWithinSubscription_List.json | 24 - ...nfigurationAssignments_CreateOrUpdate.json | 40 - ...ationAssignments_CreateOrUpdateParent.json | 42 - .../ConfigurationAssignments_Delete.json | 21 - ...ConfigurationAssignments_DeleteParent.json | 23 - .../ConfigurationAssignments_Get.json | 24 - .../ConfigurationAssignments_GetParent.json | 26 - .../ConfigurationAssignments_List.json | 27 - .../ConfigurationAssignments_ListParent.json | 29 - ...nanceConfigurationsResourceGroup_List.json | 32 - ...figurations_CreateOrUpdateForResource.json | 63 - ...nanceConfigurations_DeleteForResource.json | 21 - ...ntenanceConfigurations_GetForResource.json | 29 - ...ions_GetForResource_GuestOSPatchLinux.json | 45 - ...ns_GetForResource_GuestOSPatchWindows.json | 44 - .../MaintenanceConfigurations_List.json | 31 - ...nanceConfigurations_UpdateForResource.json | 44 - .../2023-04-01/examples/Operations_List.json | 12 - ...ntenanceConfigurations_GetForResource.json | 28 - .../PublicMaintenanceConfigurations_List.json | 31 - .../2023-04-01/examples/Updates_List.json | 28 - .../examples/Updates_ListParent.json | 30 - .../resource-manager/readme.cli.md | 57 - .../maintenance/resource-manager/readme.md | 60 +- 39 files changed, 1 insertion(+), 4545 deletions(-) delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json delete mode 100644 specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json deleted file mode 100644 index add55f4b3dd6..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/Maintenance.json +++ /dev/null @@ -1,3040 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-04-01", - "title": "MaintenanceManagementClient", - "description": "Azure Maintenance Management Client" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations": { - "get": { - "tags": [ - "PublicMaintenanceConfigurations" - ], - "summary": "Get Public Maintenance Configuration records", - "operationId": "PublicMaintenanceConfigurations_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListMaintenanceConfigurationsResult" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "PublicMaintenanceConfigurations_List": { - "$ref": "./examples/PublicMaintenanceConfigurations_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/{resourceName}": { - "get": { - "tags": [ - "PublicMaintenanceConfigurations" - ], - "summary": "Get Public Maintenance Configuration record", - "operationId": "PublicMaintenanceConfigurations_Get", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceName", - "in": "path", - "description": "Maintenance Configuration Name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MaintenanceConfiguration" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "PublicMaintenanceConfigurations_GetForResource": { - "$ref": "./examples/PublicMaintenanceConfigurations_GetForResource.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}": { - "get": { - "tags": [ - "ApplyUpdates" - ], - "summary": "Track Updates to resource with parent", - "description": "Track maintenance updates to resource with parent", - "operationId": "ApplyUpdates_GetParent", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceParentType", - "in": "path", - "description": "Resource parent type", - "required": true, - "type": "string" - }, - { - "name": "resourceParentName", - "in": "path", - "description": "Resource parent identifier", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "name": "applyUpdateName", - "in": "path", - "description": "applyUpdate Id", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplyUpdate" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ApplyUpdates_GetParent": { - "$ref": "./examples/ApplyUpdates_GetParent.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/{applyUpdateName}": { - "get": { - "tags": [ - "ApplyUpdates" - ], - "summary": "Track Updates to resource", - "description": "Track maintenance updates to resource", - "operationId": "ApplyUpdates_Get", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "name": "applyUpdateName", - "in": "path", - "description": "applyUpdate Id", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplyUpdate" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ApplyUpdates_Get": { - "$ref": "./examples/ApplyUpdates_Get.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default": { - "put": { - "tags": [ - "ApplyUpdates" - ], - "summary": "Apply Updates to resource with parent", - "description": "Apply maintenance updates to resource with parent", - "operationId": "ApplyUpdates_CreateOrUpdateParent", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceParentType", - "in": "path", - "description": "Resource parent type", - "required": true, - "type": "string" - }, - { - "name": "resourceParentName", - "in": "path", - "description": "Resource parent identifier", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplyUpdate" - } - }, - "201": { - "description": "Apply-update create request accepted", - "schema": { - "$ref": "#/definitions/ApplyUpdate" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ApplyUpdates_CreateOrUpdateParent": { - "$ref": "./examples/ApplyUpdates_CreateOrUpdateParent.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/applyUpdates/default": { - "put": { - "tags": [ - "ApplyUpdates" - ], - "summary": "Apply Updates to resource", - "description": "Apply maintenance updates to resource", - "operationId": "ApplyUpdates_CreateOrUpdate", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ApplyUpdate" - } - }, - "201": { - "description": "ApplyUpdate create request accepted", - "schema": { - "$ref": "#/definitions/ApplyUpdate" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ApplyUpdates_CreateOrUpdate": { - "$ref": "./examples/ApplyUpdates_CreateOrUpdate.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { - "get": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Get configuration assignment", - "description": "Get configuration assignment for resource..", - "operationId": "ConfigurationAssignments_GetParent", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceParentType", - "in": "path", - "description": "Resource parent type", - "required": true, - "type": "string" - }, - { - "name": "resourceParentName", - "in": "path", - "description": "Resource parent identifier", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Configuration assignment name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignments_GetParent": { - "$ref": "./examples/ConfigurationAssignments_GetParent.json" - } - } - }, - "put": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Create configuration assignment", - "description": "Register configuration for resource.", - "operationId": "ConfigurationAssignments_CreateOrUpdateParent", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceParentType", - "in": "path", - "description": "Resource parent type", - "required": true, - "type": "string" - }, - { - "name": "resourceParentName", - "in": "path", - "description": "Resource parent identifier", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Configuration assignment name", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignment", - "in": "body", - "description": "The configurationAssignment", - "required": true, - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "201": { - "description": "Configuration assignment create request accepted", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignments_CreateOrUpdateParent": { - "$ref": "./examples/ConfigurationAssignments_CreateOrUpdateParent.json" - } - } - }, - "delete": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Unregister configuration for resource", - "description": "Unregister configuration for resource.", - "operationId": "ConfigurationAssignments_DeleteParent", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceParentType", - "in": "path", - "description": "Resource parent type", - "required": true, - "type": "string" - }, - { - "name": "resourceParentName", - "in": "path", - "description": "Resource parent identifier", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Unique configuration assignment name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignments_DeleteParent": { - "$ref": "./examples/ConfigurationAssignments_DeleteParent.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { - "get": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Get configuration assignment", - "description": "Get configuration assignment for resource..", - "operationId": "ConfigurationAssignments_Get", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Configuration assignment name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignments_Get": { - "$ref": "./examples/ConfigurationAssignments_Get.json" - } - } - }, - "put": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Create configuration assignment", - "description": "Register configuration for resource.", - "operationId": "ConfigurationAssignments_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Configuration assignment name", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignment", - "in": "body", - "description": "The configurationAssignment", - "required": true, - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "201": { - "description": "Configuration assignment create request accepted", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignments_CreateOrUpdate": { - "$ref": "./examples/ConfigurationAssignments_CreateOrUpdate.json" - } - } - }, - "delete": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Unregister configuration for resource", - "description": "Unregister configuration for resource.", - "operationId": "ConfigurationAssignments_Delete", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Unique configuration assignment name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignments_Delete": { - "$ref": "./examples/ConfigurationAssignments_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments": { - "get": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "List configurationAssignments for resource", - "description": "List configurationAssignments for resource.", - "operationId": "ConfigurationAssignments_ListParent", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceParentType", - "in": "path", - "description": "Resource parent type", - "required": true, - "type": "string" - }, - { - "name": "resourceParentName", - "in": "path", - "description": "Resource parent identifier", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListConfigurationAssignmentsResult" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "ConfigurationAssignments_ListParent": { - "$ref": "./examples/ConfigurationAssignments_ListParent.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/configurationAssignments": { - "get": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "List configurationAssignments for resource", - "description": "List configurationAssignments for resource.", - "operationId": "ConfigurationAssignments_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListConfigurationAssignmentsResult" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "ConfigurationAssignments_List": { - "$ref": "./examples/ConfigurationAssignments_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations/{resourceName}": { - "get": { - "tags": [ - "MaintenanceConfigurations" - ], - "summary": "Get Configuration record", - "operationId": "MaintenanceConfigurations_Get", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource Group Name", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Maintenance Configuration Name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MaintenanceConfiguration" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "MaintenanceConfigurations_GetForResource": { - "$ref": "./examples/MaintenanceConfigurations_GetForResource.json" - }, - "MaintenanceConfigurations_GetForResource_GuestOSPatchWindows": { - "$ref": "./examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json" - }, - "MaintenanceConfigurations_GetForResource_GuestOSPatchLinux": { - "$ref": "./examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json" - } - } - }, - "put": { - "tags": [ - "MaintenanceConfigurations" - ], - "summary": "Create or Update configuration record", - "operationId": "MaintenanceConfigurations_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource Group Name", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Maintenance Configuration Name", - "required": true, - "type": "string" - }, - { - "name": "configuration", - "in": "body", - "description": "The configuration", - "required": true, - "schema": { - "$ref": "#/definitions/MaintenanceConfiguration" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MaintenanceConfiguration" - } - }, - "201": { - "description": "Maintenance configuration create request accepted", - "schema": { - "$ref": "#/definitions/MaintenanceConfiguration" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "MaintenanceConfigurations_CreateOrUpdateForResource": { - "$ref": "./examples/MaintenanceConfigurations_CreateOrUpdateForResource.json" - } - } - }, - "delete": { - "tags": [ - "MaintenanceConfigurations" - ], - "summary": "Delete Configuration record", - "operationId": "MaintenanceConfigurations_Delete", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource Group Name", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Maintenance Configuration Name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MaintenanceConfiguration" - } - }, - "204": { - "description": "No Content" - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "MaintenanceConfigurations_DeleteForResource": { - "$ref": "./examples/MaintenanceConfigurations_DeleteForResource.json" - } - } - }, - "patch": { - "tags": [ - "MaintenanceConfigurations" - ], - "summary": "Patch configuration record", - "operationId": "MaintenanceConfigurations_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource Group Name", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Maintenance Configuration Name", - "required": true, - "type": "string" - }, - { - "name": "configuration", - "in": "body", - "description": "The configuration", - "required": true, - "schema": { - "$ref": "#/definitions/MaintenanceConfiguration" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/MaintenanceConfiguration" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "MaintenanceConfigurations_UpdateForResource": { - "$ref": "./examples/MaintenanceConfigurations_UpdateForResource.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/maintenanceConfigurations": { - "get": { - "tags": [ - "MaintenanceConfigurations" - ], - "summary": "Get Configuration records within a subscription", - "operationId": "MaintenanceConfigurations_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListMaintenanceConfigurationsResult" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "MaintenanceConfigurations_List": { - "$ref": "./examples/MaintenanceConfigurations_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/maintenanceConfigurations": { - "get": { - "tags": [ - "MaintenanceConfigurations" - ], - "summary": "Get Configuration records within a subscription and resource group", - "operationId": "MaintenanceConfigurationsForResourceGroup_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource Group Name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListMaintenanceConfigurationsResult" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "MaintenanceConfigurationsResourceGroup_List": { - "$ref": "./examples/MaintenanceConfigurationsResourceGroup_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/applyUpdates": { - "get": { - "tags": [ - "ApplyUpdate" - ], - "summary": "Get Configuration records within a subscription", - "operationId": "ApplyUpdates_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListApplyUpdate" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "ApplyUpdates_List": { - "$ref": "./examples/ApplyUpdates_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Maintenance/applyUpdates": { - "get": { - "tags": [ - "ApplyUpdate" - ], - "summary": "Get Configuration records within a subscription and resource group", - "operationId": "ApplyUpdateForResourceGroup_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource Group Name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListApplyUpdate" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "ApplyUpdatesResourceGroup_List": { - "$ref": "./examples/ApplyUpdatesResourceGroup_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/configurationAssignments": { - "get": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Get configuration assignment within a subscription", - "operationId": "ConfigurationAssignmentsWithinSubscription_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListConfigurationAssignmentsResult" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "ConfigurationAssignmentsResultWithinSubscription_List": { - "$ref": "./examples/ConfigurationAssignmentsResultWithinSubscription_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { - "get": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Get configuration assignment", - "description": "Get configuration assignment for resource..", - "operationId": "ConfigurationAssignmentsForSubscriptions_Get", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Configuration assignment name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignments_GetParent": { - "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_Get.json" - } - } - }, - "put": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Create configuration assignment", - "description": "Register configuration for resource.", - "operationId": "ConfigurationAssignmentsForSubscriptions_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Configuration assignment name", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignment", - "in": "body", - "description": "The configurationAssignment", - "required": true, - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "201": { - "description": "Configuration assignment create request accepted", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignmentsForSubscriptions_CreateOrUpdate": { - "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Create configuration assignment", - "description": "Register configuration for resource.", - "operationId": "ConfigurationAssignmentsForSubscriptions_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Configuration assignment name", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignment", - "in": "body", - "description": "The configurationAssignment", - "required": true, - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignmentsForSubscriptions_CreateOrUpdate": { - "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json" - } - } - }, - "delete": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Unregister configuration for resource", - "description": "Unregister configuration for resource.", - "operationId": "ConfigurationAssignmentsForSubscriptions_Delete", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Unique configuration assignment name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "204": { - "description": "No Content" - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignmentsForSubscriptions_Delete": { - "$ref": "./examples/ConfigurationAssignmentsForSubscriptions_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Maintenance/configurationAssignments/{configurationAssignmentName}": { - "get": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Get configuration assignment", - "description": "Get configuration assignment for resource..", - "operationId": "ConfigurationAssignmentsForResourceGroup_Get", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Configuration assignment name", - "required": true, - "type": "string", - "pattern": "^.+$" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignmentsForResourceGroup_Get": { - "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_Get.json" - } - } - }, - "put": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Create configuration assignment", - "description": "Register configuration for resource.", - "operationId": "ConfigurationAssignmentsForResourceGroup_CreateOrUpdate", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Configuration assignment name", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignment", - "in": "body", - "description": "The configurationAssignment", - "required": true, - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "201": { - "description": "Configuration assignment create request accepted", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignmentsForResourceGroup_CreateOrUpdate": { - "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json" - } - } - }, - "patch": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Create configuration assignment", - "description": "Register configuration for resource.", - "operationId": "ConfigurationAssignmentsForResourceGroup_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Configuration assignment name", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignment", - "in": "body", - "description": "The configurationAssignment", - "required": true, - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignmentsForResourceGroup_CreateOrUpdate": { - "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json" - } - } - }, - "delete": { - "tags": [ - "ConfigurationAssignments" - ], - "summary": "Unregister configuration for resource", - "description": "Unregister configuration for resource.", - "operationId": "ConfigurationAssignmentsForResourceGroup_Delete", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "configurationAssignmentName", - "in": "path", - "description": "Unique configuration assignment name", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ConfigurationAssignment" - } - }, - "204": { - "description": "No Content" - }, - "202": { - "description": "Accepted" - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-examples": { - "ConfigurationAssignmentsForResourceGroup_Delete": { - "$ref": "./examples/ConfigurationAssignmentsForResourceGroup_Delete.json" - } - } - } - }, - "/providers/Microsoft.Maintenance/operations": { - "get": { - "tags": [ - "Operations" - ], - "summary": "List available operations", - "description": "List the available operations supported by the Microsoft.Maintenance resource provider", - "operationId": "Operations_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/OperationsListResult" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceParentType}/{resourceParentName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates": { - "get": { - "tags": [ - "Updates" - ], - "summary": "Get Updates to resource", - "description": "Get updates to resources.", - "operationId": "Updates_ListParent", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceParentType", - "in": "path", - "description": "Resource parent type", - "required": true, - "type": "string" - }, - { - "name": "resourceParentName", - "in": "path", - "description": "Resource parent identifier", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListUpdatesResult" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Updates_ListParent": { - "$ref": "./examples/Updates_ListParent.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{providerName}/{resourceType}/{resourceName}/providers/Microsoft.Maintenance/updates": { - "get": { - "tags": [ - "Updates" - ], - "summary": "Get Updates to resource", - "description": "Get updates to resources.", - "operationId": "Updates_List", - "consumes": [], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "name": "resourceGroupName", - "in": "path", - "description": "Resource group name", - "required": true, - "type": "string" - }, - { - "name": "providerName", - "in": "path", - "description": "Resource provider name", - "required": true, - "type": "string" - }, - { - "name": "resourceType", - "in": "path", - "description": "Resource type", - "required": true, - "type": "string" - }, - { - "name": "resourceName", - "in": "path", - "description": "Resource identifier", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ListUpdatesResult" - } - }, - "default": { - "description": "BadRequest", - "schema": { - "$ref": "#/definitions/MaintenanceError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "Updates_List": { - "$ref": "./examples/Updates_List.json" - } - } - } - } - }, - "definitions": { - "ApplyUpdateProperties": { - "description": "Properties for apply update", - "type": "object", - "properties": { - "status": { - "description": "The status", - "enum": [ - "Pending", - "InProgress", - "Completed", - "RetryNow", - "RetryLater" - ], - "type": "string", - "x-ms-enum": { - "name": "UpdateStatus", - "modelAsString": true, - "values": [ - { - "value": "Pending", - "description": "There are pending updates to be installed." - }, - { - "value": "InProgress", - "description": "Updates installation are in progress." - }, - { - "value": "Completed", - "description": "All updates are successfully applied." - }, - { - "value": "RetryNow", - "description": "Updates installation failed but are ready to retry again." - }, - { - "value": "RetryLater", - "description": "Updates installation failed and should be retried later." - } - ] - } - }, - "resourceId": { - "description": "The resourceId", - "type": "string" - }, - "lastUpdateTime": { - "format": "date-time", - "description": "Last Update time", - "type": "string" - } - } - }, - "Resource": { - "description": "Definition of a Resource", - "type": "object", - "properties": { - "id": { - "description": "Fully qualified identifier of the resource", - "type": "string", - "readOnly": true - }, - "name": { - "description": "Name of the resource", - "type": "string", - "readOnly": true - }, - "type": { - "description": "Type of the resource", - "type": "string", - "readOnly": true - }, - "systemData": { - "readOnly": true, - "type": "object", - "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", - "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData" - } - }, - "x-ms-azure-resource": true - }, - "ApplyUpdate": { - "description": "Apply Update request", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ApplyUpdateProperties", - "description": "Properties of the apply update", - "x-ms-client-flatten": true - } - } - }, - "ListApplyUpdate": { - "description": "Response for ApplyUpdate list", - "type": "object", - "properties": { - "value": { - "description": "The list of apply updates", - "type": "array", - "items": { - "$ref": "#/definitions/ApplyUpdate" - } - } - } - }, - "ConfigurationAssignmentFilterProperties": { - "type": "object", - "description": "Azure query for the update configuration.", - "properties": { - "resourceTypes": { - "type": "array", - "description": "List of allowed resources.", - "items": { - "type": "string", - "description": "List of allowed resources" - } - }, - "resourceGroups": { - "type": "array", - "description": "List of allowed resource groups.", - "items": { - "type": "string", - "description": "List of allowed resource groups" - } - }, - "osTypes": { - "type": "array", - "description": "List of allowed operating systems.", - "items": { - "type": "string", - "description": "List of allowed operating systems" - } - }, - "locations": { - "type": "array", - "description": "List of locations to scope the query to.", - "items": { - "type": "string", - "description": "Location to scope the query to." - } - }, - "tagSettings": { - "type": "object", - "description": "Tag settings for the VM.", - "$ref": "#/definitions/TagSettingsProperties" - } - } - }, - "TagSettingsProperties": { - "type": "object", - "description": "Tag filter information for the VM.", - "properties": { - "tags": { - "type": "object", - "description": "Dictionary of tags with its list of values.", - "additionalProperties": { - "type": "array", - "items": { - "type": "string", - "description": "List of tag values for a tag." - } - } - }, - "filterOperator": { - "type": "string", - "description": "Filter VMs by Any or All specified tags.", - "enum": [ - "All", - "Any" - ], - "x-ms-enum": { - "name": "TagOperators", - "modelAsString": false - } - } - } - }, - "ConfigurationAssignmentProperties": { - "description": "Properties for configuration assignment", - "type": "object", - "properties": { - "maintenanceConfigurationId": { - "description": "The maintenance configuration Id", - "type": "string" - }, - "resourceId": { - "description": "The unique resourceId", - "type": "string" - }, - "filter": { - "$ref": "#/definitions/ConfigurationAssignmentFilterProperties", - "description": "Properties of the configuration assignment" - } - } - }, - "ConfigurationAssignment": { - "description": "Configuration Assignment", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "Location of the resource", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/ConfigurationAssignmentProperties", - "description": "Properties of the configuration assignment", - "x-ms-client-flatten": true - } - } - }, - "ListConfigurationAssignmentsResult": { - "description": "Response for ConfigurationAssignments list", - "type": "object", - "properties": { - "value": { - "description": "The list of configuration Assignments", - "type": "array", - "items": { - "$ref": "#/definitions/ConfigurationAssignment" - } - } - } - }, - "MaintenanceWindow": { - "description": "Definition of a MaintenanceWindow", - "type": "object", - "properties": { - "startDateTime": { - "description": "Effective start date of the maintenance window in YYYY-MM-DD hh:mm format. The start date can be set to either the current date or future date. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone.", - "type": "string" - }, - "expirationDateTime": { - "description": "Effective expiration date of the maintenance window in YYYY-MM-DD hh:mm format. The window will be created in the time zone provided and adjusted to daylight savings according to that time zone. Expiration date must be set to a future date. If not provided, it will be set to the maximum datetime 9999-12-31 23:59:59.", - "type": "string" - }, - "duration": { - "description": "Duration of the maintenance window in HH:mm format. If not provided, default value will be used based on maintenance scope provided. Example: 05:00.", - "type": "string" - }, - "timeZone": { - "description": "Name of the timezone. List of timezones can be obtained by executing [System.TimeZoneInfo]::GetSystemTimeZones() in PowerShell. Example: Pacific Standard Time, UTC, W. Europe Standard Time, Korea Standard Time, Cen. Australia Standard Time.", - "type": "string" - }, - "recurEvery": { - "description": "Rate at which a Maintenance window is expected to recur. The rate can be expressed as daily, weekly, or monthly schedules. Daily schedule are formatted as recurEvery: [Frequency as integer]['Day(s)']. If no frequency is provided, the default frequency is 1. Daily schedule examples are recurEvery: Day, recurEvery: 3Days. Weekly schedule are formatted as recurEvery: [Frequency as integer]['Week(s)'] [Optional comma separated list of weekdays Monday-Sunday]. Weekly schedule examples are recurEvery: 3Weeks, recurEvery: Week Saturday,Sunday. Monthly schedules are formatted as [Frequency as integer]['Month(s)'] [Comma separated list of month days] or [Frequency as integer]['Month(s)'] [Week of Month (First, Second, Third, Fourth, Last)] [Weekday Monday-Sunday] [Optional Offset(No. of days)]. Offset value must be between -6 to 6 inclusive. Monthly schedule examples are recurEvery: Month, recurEvery: 2Months, recurEvery: Month day23,day24, recurEvery: Month Last Sunday, recurEvery: Month Fourth Monday, recurEvery: Month Last Sunday Offset-3, recurEvery: Month Third Sunday Offset6.", - "type": "string" - } - } - }, - "MaintenanceConfigurationProperties": { - "description": "Properties for maintenance configuration", - "type": "object", - "properties": { - "namespace": { - "description": "Gets or sets namespace of the resource", - "type": "string" - }, - "extensionProperties": { - "description": "Gets or sets extensionProperties of the maintenanceConfiguration", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "maintenanceScope": { - "description": "Gets or sets maintenanceScope of the configuration", - "enum": [ - "Host", - "Resource", - "OSImage", - "Extension", - "InGuestPatch", - "SQLDB", - "SQLManagedInstance" - ], - "type": "string", - "x-ms-enum": { - "name": "MaintenanceScope", - "modelAsString": true, - "values": [ - { - "value": "Host", - "description": "This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs." - }, - { - "value": "Resource", - "description": "This maintenance scope controls the default update maintenance of the Azure Resource" - }, - { - "value": "OSImage", - "description": "This maintenance scope controls os image installation on VM/VMSS" - }, - { - "value": "Extension", - "description": "This maintenance scope controls extension installation on VM/VMSS" - }, - { - "value": "InGuestPatch", - "description": "This maintenance scope controls installation of windows and linux packages on VM/VMSS" - }, - { - "value": "SQLDB", - "description": "This maintenance scope controls installation of SQL server platform updates." - }, - { - "value": "SQLManagedInstance", - "description": "This maintenance scope controls installation of SQL managed instance platform update." - } - ] - } - }, - "maintenanceWindow": { - "$ref": "#/definitions/MaintenanceWindow", - "description": "Definition of a MaintenanceWindow", - "x-ms-client-flatten": true - }, - "visibility": { - "description": "Gets or sets the visibility of the configuration. The default value is 'Custom'", - "enum": [ - "Custom", - "Public" - ], - "type": "string", - "x-ms-enum": { - "name": "Visibility", - "modelAsString": true, - "values": [ - { - "value": "Custom", - "description": "Only visible to users with permissions." - }, - { - "value": "Public", - "description": "Visible to all users." - } - ] - } - }, - "installPatches": { - "$ref": "#/definitions/InputPatchConfiguration", - "description": "The input parameters to be passed to the patch run operation." - } - } - }, - "InputPatchConfiguration": { - "type": "object", - "properties": { - "rebootSetting": { - "type": "string", - "enum": [ - "IfRequired", - "Never", - "Always" - ], - "x-ms-enum": { - "name": "RebootOptions", - "modelAsString": true - }, - "default": "IfRequired", - "description": "Possible reboot preference as defined by the user based on which it would be decided to reboot the machine or not after the patch operation is completed." - }, - "windowsParameters": { - "$ref": "#/definitions/InputWindowsParameters", - "description": "Input parameters specific to patching a Windows machine. For Linux machines, do not pass this property." - }, - "linuxParameters": { - "$ref": "#/definitions/InputLinuxParameters", - "description": "Input parameters specific to patching Linux machine. For Windows machines, do not pass this property." - } - }, - "description": "Input configuration for a patch run" - }, - "InputWindowsParameters": { - "type": "object", - "properties": { - "kbNumbersToExclude": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Windows KBID to be excluded for patching." - }, - "kbNumbersToInclude": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Windows KBID to be included for patching." - }, - "classificationsToInclude": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Classification category of patches to be patched" - }, - "excludeKbsRequiringReboot": { - "type": "boolean", - "description": "Exclude patches which need reboot" - } - }, - "description": "Input properties for patching a Windows machine." - }, - "InputLinuxParameters": { - "type": "object", - "properties": { - "packageNameMasksToExclude": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Package names to be excluded for patching." - }, - "packageNameMasksToInclude": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Package names to be included for patching." - }, - "classificationsToInclude": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Classification category of patches to be patched" - } - }, - "description": "Input properties for patching a Linux machine." - }, - "MaintenanceConfiguration": { - "description": "Maintenance configuration record type", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "description": "Gets or sets location of the resource", - "type": "string" - }, - "tags": { - "description": "Gets or sets tags of the resource", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/MaintenanceConfigurationProperties", - "description": "Gets or sets properties of the resource", - "x-ms-client-flatten": true - } - } - }, - "MaintenanceError": { - "description": "An error response received from the Azure Maintenance service.", - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/ErrorDetails", - "description": "Details of the error" - } - } - }, - "ErrorDetails": { - "description": "An error response details received from the Azure Maintenance service.", - "type": "object", - "properties": { - "code": { - "description": "Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.", - "type": "string" - }, - "message": { - "description": "Human-readable representation of the error.", - "type": "string" - } - } - }, - "ListMaintenanceConfigurationsResult": { - "description": "Response for MaintenanceConfigurations list", - "type": "object", - "properties": { - "value": { - "description": "The list of maintenance Configurations", - "type": "array", - "items": { - "$ref": "#/definitions/MaintenanceConfiguration" - } - } - } - }, - "OperationsListResult": { - "description": "Result of the List Operations operation", - "type": "object", - "properties": { - "value": { - "description": "A collection of operations", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "x-ms-identifiers": [ - "name" - ] - } - } - }, - "Operation": { - "description": "Represents an operation returned by the GetOperations request", - "type": "object", - "properties": { - "name": { - "description": "Name of the operation", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationInfo", - "description": "Display name of the operation" - }, - "origin": { - "description": "Origin of the operation", - "type": "string" - }, - "properties": { - "description": "Properties of the operation", - "type": "object", - "x-ms-client-flatten": true - }, - "isDataAction": { - "description": "Indicates whether the operation is a data action", - "type": "boolean" - } - } - }, - "OperationInfo": { - "description": "Information about an operation", - "type": "object", - "properties": { - "provider": { - "description": "Name of the provider", - "type": "string" - }, - "resource": { - "description": "Name of the resource type", - "type": "string" - }, - "operation": { - "description": "Name of the operation", - "type": "string" - }, - "description": { - "description": "Description of the operation", - "type": "string" - } - } - }, - "ListUpdatesResult": { - "description": "Response for Updates list", - "type": "object", - "properties": { - "value": { - "description": "The pending updates", - "type": "array", - "items": { - "$ref": "#/definitions/Update" - }, - "x-ms-identifiers": [] - } - } - }, - "Update": { - "description": "Maintenance update on a resource", - "type": "object", - "properties": { - "maintenanceScope": { - "description": "The impact area", - "enum": [ - "Host", - "Resource", - "OSImage", - "Extension", - "InGuestPatch", - "SQLDB", - "SQLManagedInstance" - ], - "type": "string", - "x-ms-enum": { - "name": "MaintenanceScope", - "modelAsString": true, - "values": [ - { - "value": "Host", - "description": "This maintenance scope controls installation of azure platform updates i.e. services on physical nodes hosting customer VMs." - }, - { - "value": "Resource", - "description": "This maintenance scope controls the default update maintenance of the Azure Resource" - }, - { - "value": "OSImage", - "description": "This maintenance scope controls os image installation on VM/VMSS" - }, - { - "value": "Extension", - "description": "This maintenance scope controls extension installation on VM/VMSS" - }, - { - "value": "InGuestPatch", - "description": "This maintenance scope controls installation of windows and linux packages on VM/VMSS" - }, - { - "value": "SQLDB", - "description": "This maintenance scope controls installation of SQL server platform updates." - }, - { - "value": "SQLManagedInstance", - "description": "This maintenance scope controls installation of SQL managed instance platform update." - } - ] - } - }, - "impactType": { - "description": "The impact type", - "enum": [ - "None", - "Freeze", - "Restart", - "Redeploy" - ], - "type": "string", - "x-ms-enum": { - "name": "ImpactType", - "modelAsString": true, - "values": [ - { - "value": "None", - "description": "Pending updates has no impact on resource." - }, - { - "value": "Freeze", - "description": "Pending updates can freeze network or disk io operation on resource." - }, - { - "value": "Restart", - "description": "Pending updates can cause resource to restart." - }, - { - "value": "Redeploy", - "description": "Pending updates can redeploy resource." - } - ] - } - }, - "status": { - "description": "The status", - "enum": [ - "Pending", - "InProgress", - "Completed", - "RetryNow", - "RetryLater" - ], - "type": "string", - "x-ms-enum": { - "name": "UpdateStatus", - "modelAsString": true, - "values": [ - { - "value": "Pending", - "description": "There are pending updates to be installed." - }, - { - "value": "InProgress", - "description": "Updates installation are in progress." - }, - { - "value": "Completed", - "description": "All updates are successfully applied." - }, - { - "value": "RetryNow", - "description": "Updates installation failed but are ready to retry again." - }, - { - "value": "RetryLater", - "description": "Updates installation failed and should be retried later." - } - ] - } - }, - "impactDurationInSec": { - "format": "int32", - "description": "Duration of impact in seconds", - "type": "integer" - }, - "notBefore": { - "format": "date-time", - "description": "Time when Azure will start force updates if not self-updated by customer before this time", - "type": "string" - }, - "properties": { - "$ref": "#/definitions/UpdateProperties", - "description": "Properties of the apply update", - "x-ms-client-flatten": true - } - } - }, - "UpdateProperties": { - "description": "Properties for update", - "type": "object", - "properties": { - "resourceId": { - "description": "The resourceId", - "type": "string" - } - } - } - }, - "parameters": { - "SubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - }, - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Version of the API to be used with the client request.", - "required": true, - "type": "string", - "x-ms-parameter-location": "client" - } - }, - "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" - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json deleted file mode 100644 index cd68c3164dd9..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdatesResourceGroup_List.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Maintenance", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "type": "Microsoft.Maintenance/applyUpdates", - "properties": { - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", - "status": "Completed" - } - } - ] - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json deleted file mode 100644 index 033b3b9c6c46..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdate.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceType": "virtualMachineScaleSets", - "resourceName": "smdtest1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "type": "Microsoft.Maintenance/applyUpdates", - "properties": { - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", - "status": "Pending" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "type": "Microsoft.Maintenance/applyUpdates", - "properties": { - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", - "status": "Pending" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json deleted file mode 100644 index a001eb591eda..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_CreateOrUpdateParent.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceParentType": "virtualMachineScaleSets", - "resourceParentName": "smdtest1", - "resourceType": "virtualMachines", - "resourceName": "smdvm1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "type": "Microsoft.Maintenance/applyUpdates", - "properties": { - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1", - "status": "Pending" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "type": "Microsoft.Maintenance/applyUpdates", - "properties": { - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1", - "status": "Pending" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json deleted file mode 100644 index d09ac9b2d231..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_Get.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceType": "virtualMachineScaleSets", - "resourceName": "smdtest1", - "applyUpdateName": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "type": "Microsoft.Maintenance/applyUpdates", - "properties": { - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", - "status": "Completed" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json deleted file mode 100644 index b1b99728c9c5..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_GetParent.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceParentType": "virtualMachineScaleSets", - "resourceParentName": "smdtest1", - "resourceType": "virtualMachines", - "resourceName": "smdvm1", - "applyUpdateName": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "type": "Microsoft.Maintenance/applyUpdates", - "properties": { - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1", - "status": "Completed" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json deleted file mode 100644 index 063401144973..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ApplyUpdates_List.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "providerName": "Microsoft.Maintenance", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/applyUpdates/e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "name": "e9b9685d-78e4-44c4-a81c-64a14f9b87b6", - "type": "Microsoft.Maintenance/applyUpdates", - "properties": { - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1", - "status": "Completed" - } - } - ] - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json deleted file mode 100644 index 2734f84cedf5..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_CreateOrUpdate.json +++ /dev/null @@ -1,116 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01", - "configurationAssignment": { - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "Any" - }, - "locations": [ - "Japan East", - "UK South" - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg", - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "osTypes": [ - "Windows", - "Linux" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "Any" - }, - "locations": [ - "Japan East", - "UK South" - ] - } - } - } - }, - "201": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg", - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "Any" - }, - "locations": [ - "Japan East", - "UK South" - ] - } - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json deleted file mode 100644 index c10ba96f4137..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Delete.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments" - } - }, - "204": {}, - "202": {} - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json deleted file mode 100644 index b1e6d6dd32f3..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_Get.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "All" - }, - "locations": [ - "Japan East", - "UK South" - ] - }, - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json deleted file mode 100644 index cb3f11dabc9c..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForResourceGroup_UpdateForResource.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01", - "configurationAssignment": { - "properties": { - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "Any" - }, - "locations": [ - "Japan East", - "UK South" - ] - }, - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "Any" - }, - "locations": [ - "Japan East", - "UK South" - ] - }, - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json deleted file mode 100644 index eb829877dc09..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_CreateOrUpdate.json +++ /dev/null @@ -1,123 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01", - "configurationAssignment": { - "properties": { - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "resourceGroups": [ - "RG1", - "RG2" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "Any" - }, - "locations": [ - "Japan East", - "UK South" - ] - }, - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "resourceGroups": [ - "RG1", - "RG2" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "Any" - }, - "locations": [ - "Japan East", - "UK South" - ] - }, - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "resourceGroups": [ - "RG1", - "RG2" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "Any" - }, - "locations": [ - "Japan East", - "UK South" - ] - }, - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json deleted file mode 100644 index 6ed5b0bbebd7..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Delete.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments" - } - }, - "204": {}, - "202": {} - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json deleted file mode 100644 index e967df973f8e..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_Get.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "All" - }, - "locations": [ - "Japan East", - "UK South" - ] - }, - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json deleted file mode 100644 index 466240c709cc..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsForSubscriptions_UpdateForResource.json +++ /dev/null @@ -1,83 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01", - "configurationAssignment": { - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "resourceGroups": [ - "RG1", - "RG2" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "Any" - }, - "locations": [ - "Japan East", - "UK South" - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "filter": { - "resourceTypes": [ - "Microsoft.HybridCompute/machines", - "Microsoft.Compute/virtualMachines" - ], - "resourceGroups": [ - "RG1", - "RG2" - ], - "tagSettings": { - "tags": { - "tag1": [ - "tag1Value1", - "tag1Value2", - "tag1Value3" - ], - "tag2": [ - "tag2Value1", - "tag2Value2", - "tag2Value3" - ] - }, - "filterOperator": "Any" - }, - "locations": [ - "Japan East", - "UK South" - ] - } - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json deleted file mode 100644 index 4d8553b74212..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignmentsResultWithinSubscription_List.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "providerName": "Microsoft.Maintenance", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" - } - } - ] - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json deleted file mode 100644 index e1a48bb1df9a..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceType": "virtualMachineScaleSets", - "resourceName": "smdtest1", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01", - "configurationAssignment": { - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json deleted file mode 100644 index 90379b5f9355..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_CreateOrUpdateParent.json +++ /dev/null @@ -1,42 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceParentType": "virtualMachineScaleSets", - "resourceParentName": "smdtest1", - "resourceType": "virtualMachines", - "resourceName": "smdvm1", - "configurationAssignmentName": "workervmPolicy", - "api-version": "2023-04-01", - "configurationAssignment": { - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", - "name": "workervmPolicy", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", - "name": "workervmPolicy", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json deleted file mode 100644 index a85db48b8f6b..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Delete.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceType": "virtualMachineScaleSets", - "resourceName": "smdtest1", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments" - } - }, - "204": {} - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json deleted file mode 100644 index b908aac66f4b..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_DeleteParent.json +++ /dev/null @@ -1,23 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceParentType": "virtualMachineScaleSets", - "resourceParentName": "smdtest1", - "resourceType": "virtualMachines", - "resourceName": "smdvm1", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments" - } - }, - "204": {} - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json deleted file mode 100644 index 901fd7a6c61c..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_Get.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceType": "virtualMachineScaleSets", - "resourceName": "smdtest1", - "configurationAssignmentName": "workervmConfiguration", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json deleted file mode 100644 index f86089fa0766..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_GetParent.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceParentType": "virtualMachineScaleSets", - "resourceParentName": "smdtest1", - "resourceType": "virtualMachines", - "resourceName": "smdvm1", - "configurationAssignmentName": "workervmPolicy", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", - "name": "workervmPolicy", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdvm1" - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json deleted file mode 100644 index 6f04597d4763..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_List.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceType": "virtualMachineScaleSets", - "resourceName": "smdtest1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/providers/Microsoft.Maintenance/configurationAssignments/workervmConfiguration", - "name": "workervmConfiguration", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" - } - } - ] - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json deleted file mode 100644 index 7a21a5852970..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/ConfigurationAssignments_ListParent.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceParentType": "virtualMachineScaleSets", - "resourceParentName": "smdtest1", - "resourceType": "virtualMachines", - "resourceName": "smdtestvm1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdtestvm1/providers/Microsoft.Maintenance/configurationAssignments/workervmPolicy", - "name": "workervmPolicy", - "type": "Microsoft.Maintenance/configurationAssignments", - "properties": { - "maintenanceConfigurationId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/policy1", - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/smdtestvm1" - } - } - ] - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json deleted file mode 100644 index 7f19b3dff9ab..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurationsResourceGroup_List.json +++ /dev/null @@ -1,32 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "maintenanceScope": "OSImage", - "visibility": "Custom", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "Week Saturday,Sunday" - } - } - } - ] - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json deleted file mode 100644 index 101c9375b0cf..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_CreateOrUpdateForResource.json +++ /dev/null @@ -1,63 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "resourceName": "configuration1", - "api-version": "2023-04-01", - "configuration": { - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "visibility": "Custom", - "maintenanceScope": "OSImage", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "Day" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "visibility": "Custom", - "maintenanceScope": "OSImage", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "Day" - } - } - } - }, - "201": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "visibility": "Custom", - "maintenanceScope": "OSImage", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "Day" - } - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json deleted file mode 100644 index b542151adb94..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_DeleteForResource.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "resourceName": "example1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance" - } - } - }, - "204": {} - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json deleted file mode 100644 index 469d307bcf79..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource.json +++ /dev/null @@ -1,29 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "resourceName": "configuration1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "maintenanceScope": "OSImage", - "visibility": "Custom", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "5Days" - } - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json deleted file mode 100644 index cb34ac5c9869..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchLinux.json +++ /dev/null @@ -1,45 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "resourceName": "configuration1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "maintenanceScope": "InGuestPatch", - "visibility": "Custom", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "5Days" - }, - "installPatches": { - "linuxParameters": { - "classificationsToInclude": [ - "Critical" - ], - "packageNameMasksToExclude": [ - "apt", - "http" - ], - "packageNameMasksToInclude": [ - "binutils", - "bin" - ] - }, - "rebootSetting": "Always" - } - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json deleted file mode 100644 index 381f3a0f9eef..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_GetForResource_GuestOSPatchWindows.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "resourceName": "configuration1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "maintenanceScope": "InGuestPatch", - "visibility": "Custom", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "5Days" - }, - "installPatches": { - "windowsParameters": { - "classificationsToInclude": [ - "Security" - ], - "kbNumbersToInclude": [ - "KB123456" - ], - "kbNumbersToExclude": [ - "KB234567" - ], - "excludeKbsRequiringReboot": false - }, - "rebootSetting": "Always" - } - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json deleted file mode 100644 index d05c74071df8..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_List.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "maintenanceScope": "OSImage", - "visibility": "Custom", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "Week Saturday,Sunday" - } - } - } - ] - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json deleted file mode 100644 index e9055dfafa0d..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/MaintenanceConfigurations_UpdateForResource.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "resourceName": "configuration1", - "api-version": "2023-04-01", - "configuration": { - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "visibility": "Custom", - "maintenanceScope": "OSImage", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "Month Third Sunday" - } - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Maintenance/maintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "maintenanceScope": "OSImage", - "visibility": "Custom", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "Month Third Sunday" - } - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json deleted file mode 100644 index 77c3ae6d7e29..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Operations_List.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [] - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json deleted file mode 100644 index 03b7d9387f4a..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_GetForResource.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceName": "configuration1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "maintenanceScope": "SQLDB", - "visibility": "Public", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00", - "expirationDateTime": "9999-12-31 00:00", - "duration": "05:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "2Weeks" - } - } - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json deleted file mode 100644 index 9582630da1ca..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/PublicMaintenanceConfigurations_List.json +++ /dev/null @@ -1,31 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.Maintenance/publicMaintenanceConfigurations/configuration1", - "name": "configuration1", - "location": "westus2", - "properties": { - "namespace": "Microsoft.Maintenance", - "maintenanceScope": "SQLDB", - "visibility": "Public", - "maintenanceWindow": { - "startDateTime": "2020-04-30 08:00:00", - "expirationDateTime": "9999-12-31 00:00:00", - "duration": "05:00:00", - "timeZone": "Pacific Standard Time", - "recurEvery": "Week Saturday,Sunday" - } - } - } - ] - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json deleted file mode 100644 index 47d012abf1f6..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_List.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceType": "virtualMachineScaleSets", - "resourceName": "smdtest1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "maintenanceScope": "Resource", - "status": "Pending", - "impactType": "Reboot", - "impactDurationInSec": 1440, - "notBefore": "2018-10-09T06:17:44.235Z", - "properties": { - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1" - } - } - ] - } - } - } -} diff --git a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json b/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json deleted file mode 100644 index 803de75968f0..000000000000 --- a/specification/maintenance/resource-manager/Microsoft.Maintenance/stable/2023-04-01/examples/Updates_ListParent.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", - "resourceGroupName": "examplerg", - "providerName": "Microsoft.Compute", - "resourceParentType": "virtualMachineScaleSets", - "resourceParentName": "smdtest1", - "resourceType": "virtualMachines", - "resourceName": "1", - "api-version": "2023-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "maintenanceScope": "Resource", - "status": "Pending", - "impactType": "Reboot", - "impactDurationInSec": 1440, - "notBefore": "2018-10-09T06:17:44.235Z", - "properties": { - "resourceId": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourcegroups/examplerg/providers/Microsoft.Compute/virtualMachineScaleSets/smdtest1/virtualMachines/1" - } - } - ] - } - } - } -} diff --git a/specification/maintenance/resource-manager/readme.cli.md b/specification/maintenance/resource-manager/readme.cli.md index 784dfcef420a..0327c7451143 100644 --- a/specification/maintenance/resource-manager/readme.cli.md +++ b/specification/maintenance/resource-manager/readme.cli.md @@ -6,61 +6,4 @@ These settings apply only when `--cli` is specified on the command line. cli: namespace: azure.mgmt.maintenance flatten-all: true - cli-directive: - - select: 'operationGroup' - where: - operationGroup: 'ApplyUpdateForResourceGroup' - hidden: true - - where: - operationGroup: 'MaintenanceConfigurationsForResourceGroup' - hidden: true - - where: - operationGroup: 'ConfigurationAssignmentsWithinSubscription' - hidden: true - - select: 'parameter' - where: - parameter: duration - alias: - - maintenance-window-duration - - duration - - where: - parameter: 'expirationDateTime' - alias: - - maintenance-window-expiration-date-time - - expiration-date-time - - where: - parameter: 'recurEvery' - alias: - - maintenance-window-recur-every - - recur-every - - where: - param: startDateTime - alias: - - maintenance-window-start-date-time - - start-date-time - - where: - param: timeZone - alias: - - maintenance-window-time-zone - - time-zone - - where: - param: linuxParameters - alias: - - install-patches-linux-parameters - - linux-parameters - - where: - param: windowsParameters - alias: - - install-patches-windows-parameters - - windows-parameters - - where: - param: postTasks - alias: - - install-patches-post-tasks - - post-tasks - - where: - param: preTasks - alias: - - install-patches-pre-tasks - - pre-tasks ``` diff --git a/specification/maintenance/resource-manager/readme.md b/specification/maintenance/resource-manager/readme.md index 59222a780ca0..44bc36144a1f 100644 --- a/specification/maintenance/resource-manager/readme.md +++ b/specification/maintenance/resource-manager/readme.md @@ -26,17 +26,9 @@ These are the global settings for the Azure Maintenance API. ``` yaml openapi-type: arm -tag: package-2023-04 +tag: package-preview-2022-11 ``` -### Tag: package-2023-04 - -These settings apply only when `--tag=package-2023-04` is specified on the command line. - -```yaml $(tag) == 'package-2023-04' -input-file: - - Microsoft.Maintenance/stable/2023-04-01/Maintenance.json -``` ### Tag: package-preview-2022-11 @@ -46,7 +38,6 @@ These settings apply only when `--tag=package-preview-2022-11` is specified on t input-file: - Microsoft.Maintenance/preview/2022-11-01-preview/Maintenance.json ``` - ### Tag: package-preview-2022-07 These settings apply only when `--tag=package-preview-2022-07` is specified on the command line. @@ -155,52 +146,3 @@ See configuration in [readme.go.md](./readme.go.md) ## Java See configuration in [readme.java.md](./readme.java.md) - -### Suppression - -``` yaml -directive: - - suppress: PathForPutOperation - from: maintenance.json - reason: Subscription or resource group is passed in request body. - - suppress: DeleteResponseBodyEmpty - from: maintenance.json - reason: Suppression warning to avoid breaking changes - - suppress: PathContainsResourceType - from: maintenance.json - reason: Suppression warning to avoid breaking changes - - suppress: PathContainsResourceType - from: maintenance.json - reason: Suppression warning to avoid breaking changes - - suppress: TrackedResourcePatchOperation - from: maintenance.json - reason: Suppression warning to avoid breaking changes - - suppress: SubscriptionsAndResourceGroupCasing - from: maintenance.json - reason: Suppression warning to avoid breaking changes - - suppress: UnSupportedPatchProperties - from: maintenance.json - reason: Suppression warning to avoid breaking changes - - suppress: PathResourceProviderNamePascalCase - from: maintenance.json - reason: Suppression warning to avoid breaking changes - - suppress: RequestSchemaForTrackedResourcesMustHaveTags - from: maintenance.json - reason: False positive. ConfigurationAssignments is proxy resource at subscription/resourceGroup level. - - suppress: ResourceNameRestriction - from: maintenance.json - reason: Maintenance RP accept any string, no special restriction required. - - suppress: PutResponseSchemaDescription - from: maintenance.json - reason: No documentation changes. - - suppress: DeleteOperationAsyncResponseValidation - from: maintenance.json - reason: No async operation supported by Mantenance RP. - - suppress: LroLocationHeader - from: maintenance.json - reason: No async operation supported by Mantenance RP. - - suppress: LroErrorContent - from: maintenance.json - reason: No documentation changes. -``` - From 719eeab635fd4c21d6e849bb3b64e60423fbee2f Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Fri, 12 May 2023 06:09:33 +0800 Subject: [PATCH 62/79] Updated common script part in typespec e2e doc (#23875) * Updated common script part in typespec e2e doc * Update documentation/typespec-end-to-end-scenarios.md Co-authored-by: Wes Haggard * Update documentation/typespec-end-to-end-scenarios.md Co-authored-by: Wes Haggard * Resolve comments * Refactor the content * Update bulletin --------- Co-authored-by: Wes Haggard --- .../typespec-end-to-end-scenarios.md | 153 ++++++++++-------- 1 file changed, 83 insertions(+), 70 deletions(-) diff --git a/documentation/typespec-end-to-end-scenarios.md b/documentation/typespec-end-to-end-scenarios.md index 692e58482147..3084153e2be3 100644 --- a/documentation/typespec-end-to-end-scenarios.md +++ b/documentation/typespec-end-to-end-scenarios.md @@ -4,22 +4,30 @@ It is crucial having simple and smooth processes that allow developer to easily: -1. [Scaffolding TypeSpec project in `rest-api-specs` repo](#1-typespec-project-scaffolding) -2. [SDK code generation in SDK repos](#2-sdk-code-generation) - 1. All SDK required information (SDK path, namespace etc) should be set in `tspconfig.yaml`. - 2. Single call via `eng/scripts` in each language repo to complete the task - 3. Optional, intelligent CI pipeline component to create related PRs when a new service API PR is submitted. -3. [TypeSpec inner dev loop](#3-inner-dev-loop-sdk-generation-local-scenario) - 1. For spec writers: - 1. locally preview generated Swagger file - 2. gather relevant files to generate rest-api-spec PRs with green CI results - 2. For SDK writers or testing - 1. locally preview generated SDK files - 2. generating SDK PRs from checked in TypeSpec files in rest-api-spec with APIView - 3. any CI failures can be reproduced locally -4. [Typespec outer dev loop `rest-api-specs`](#4-outer-loop-overall-status-and-tracking). - 1. [Spec repo outer dev loop](#41-outer-dev-loop-azure-rest-api-specs-pipeline) - 2. [SDK outer dev loop](#42-outer-dev-loop-sdk-repo-pipeline) +- [TypeSpec end to end scenarios](#typespec-end-to-end-scenarios) + - [Scenario definitions](#scenario-definitions) + - [Four main user scenarios to support](#four-main-user-scenarios-to-support) + - [1. TypeSpec project scaffolding](#1-typespec-project-scaffolding) + - [Flowchart](#flowchart) + - [Remaining Tasks](#remaining-tasks) + - [Details \& Open questions](#details--open-questions) + - [2. SDK code generation](#2-sdk-code-generation) + - [Flowchart](#flowchart-1) + - [Remaining Tasks](#remaining-tasks-1) + - [3. Inner Dev loop SDK generation local scenario](#3-inner-dev-loop-sdk-generation-local-scenario) + - [Flowchart](#flowchart-2) + - [Remaining Tasks](#remaining-tasks-2) + - [Details \& Open questions](#details--open-questions-1) + - [4.Dev Outer loop](#4dev-outer-loop) + - [Use case](#use-case) + - [4.1 Outer Dev loop azure-rest-api-specs pipeline](#41-outer-dev-loop-azure-rest-api-specs-pipeline) + - [Flowchart](#flowchart-3) + - [Details \& Open questions](#details--open-questions-2) + - [4.2 Outer Dev loop SDK repo pipeline](#42-outer-dev-loop-sdk-repo-pipeline) + - [Flowchart](#flowchart-4) + - [Details \& Open questions](#details--open-questions-3) + - [4. Outer loop Overall Status and tracking](#4-outer-loop-overall-status-and-tracking) + - [Remaining Tasks](#remaining-tasks-3) Aside from the developer process, we have a few goals on managing repo package version - Should adopt a centralized package version control to avoid chaos @@ -68,57 +76,71 @@ classDef grey fill:#CCCCCC,color:#555555; User((::))-->A A["clone Rest-API and SDK repo locally"] --> B B["2.1 pre-requsite dependencies installation -(each language would have a installation script)"] --> C -C["2.2 TypeSpec-Project-Sync.ps1 -(a.create tsp-location.yaml and drop to temp location -b.update tsp-location.yaml if existed -c.fetch specs from remote spec repo or use local spec repo)"] --> D - D["2.3 TypeSpec-Project-Generate.ps1 -(a.create scaffolding for new project -b.update tsp-location.yaml -c.copy typespec specs to temp folder -d.generate sdk code)"] -D-->E["code build"] +(each language would have a installation script)"] --> G +subgraph G["run `2.2 TypeSpec-Project-Prcoess.ps1`"] + F + C + D +end +F["2.2.1 create/update tsp-location.yaml"] +C["2.2.2 call TypeSpec-Project-Sync.ps1"] +D["2.2.3 call TypeSpec-Project-Generate.ps1"] +G-->E["code build"] class A,E grey -class C,D highlight +class C,D,F highlight ``` -- 2.2 `TypeSpec-Project-Sync.ps1` - - input: - - sdkProjectDirectory - - typespecProjectDirectory - - repo - - commit - - additionalDirectories - - localMode (use local spec and don't fetch from remote) - - localSpecRepoPath - Note: we might pull out tsp-location.yaml create/update part as single script to be used by #2 scenario - - output: - - path of sdkProjectDirectory +- 2.1 Optional: Scripts should exist under `\eng\scripts\` folder on all repos. -- Function `Get-{Language}-Tsp-Location-Path` - - input: sdkProjectDirectory - - output: path of tsp-location.yaml +- 2.2 `TypeSpec-Project-Process.ps1` + - What does this script do? + - fetch `tspconfig.yaml` from remote if it doesn’t exist locally + - parse `tspconfig.yaml` + - create an sdk project folder if none exists + - create/update `tsp-location.yaml` + - call `TypeSpec-Project-Sync.ps1` + - call `TypeSpec-Project-Generate.ps1` + - input: + - typespecProjectDirectory (required) + either a folder of `tspconfig.yaml` or a remoteUrl of `tspconfig.yaml` + - commitSha (optional) + - repoUrl (optional) + - output: n/a -- 2.3 `TypeSpec-Project-Generate.ps1` - - input: - - projectDirectory - - typespecAdditionalOptions (emitter options) +- 2.2.2 `TypeSpec-Project-Sync.ps1` + - What does this script do? + - fetch specs from remote spec repo or use a local spec repo + - copy specs to temp location under the sdk project folder + - support a local spec repo if one exists (TODO) + - input: + - projectDirectory (required) + - localSpecRepoPath (optional) + - output: n/a -- Function `Generate-{Language}-New-Project-Scaffolding` - - input: path of tsp-location.yaml +- 2.2.3 `TypeSpec-Project-Generate.ps1` + - What does this script do? + - create scaffolding for new project (use the folder created by 2.2) + - generate sdk code + - input: + - projectDirectory (required) + - typespecAdditionalOptions (emitter options) (optional) + +- 2.2.3.1 Function `Generate-{Language}-New-Project-Scaffolding` + - What does this function do? + - Create the folders and the files under SDK project folder, such as creating `test` folder, `sln` files that would vary between language repos. Eventually, this project scaffolding would be integrated into language emitter. + - Create or update the files outside of the SDK project folder (CI.yml or pom.xml for java, etc.) + - This function is called by generate script(2.4) + - input: projectDirectory (required) ##### Remaining Tasks | Step | Step Detail | Assignee | Implemented | Verified | |--|--|--|--:|--:| | 2.1 | Dependencies scripts | SDK owner | [ ] | [] | -| 2.2 | common script | EngSys | [ ] | | [ ] | -| 2.3 | common script | EngSys | [ ] | | [ ] | -| 2.4 | language script to call common script | SDK owner | [] | [] -| 2.5 | update to dotnet build target | Michael, Crystal | [] | [] - -##### Details & Open questions -- 2.1 Optional: Scripts should exists under `\eng\scripts\` folder on all repos. -- 2.2 would involve more than just creating folder and generate `tsp-location.yaml`. There are other custom steps such as creating `test` folder, `sln` files that would vary between language repos. +| 2.2 | TypeSpec-Project-Process.ps1 | EngSys | [ ] | | [ ] | +| 2.2.2 | TypeSpec-Project-Sync.ps1 | EngSys | [ ] | | [ ] | +| 2.2.3 | TypeSpec-Project-Generate.ps1 | EngSys | [ ] | | [ ] | +| 2.2.3.1 | Generate-{Language}-New-Project-Scaffolding | SDK owner | [ ] | | [ ] | +| 2.3 | Language script to call common script | SDK owner | [] | [] +| 2.4 | Update dotnet build target | Michael, Crystal | [] | [] #### 3. Inner Dev loop SDK generation local scenario ##### Flowchart @@ -137,11 +159,10 @@ flowchart TD; F["docker run (a. call `initScript` - 2.1 b. call `generateScript` - (2.2 + 2.3) )"]-->I + (call 2.2) )"]-->I D-->K K["optional:2.1"]-->G - G["2.2"]-->H - H["2.3"]-->I + G["2.2"]-->I I["build code and work on test,sample,readme,etc."]-->J I-->|loop|B J["create sdk PR"] @@ -195,10 +216,8 @@ C["run `initScript` (2.1)"]-->G subgraph D["run `generateScript`"] G - H end -G["2.2"]-->H -H["2.3"]-->I +G["2.2"]-->I I["package sdk code"]-->J J["optional:build code and run test"]-->K K["upload artifacts"]-->L @@ -236,17 +255,11 @@ A["run `initScript` (2.1)"]-->C subgraph B["run `generateScript`"] C - D E F G end -C["2.2 -(a.use existing tsp-location.yaml -b.fetch specs from remote spec repo -c.then copy typespec specs to temp folder)"]-->D -D["2.3 -(generate sdk code)"]-->E +C["call 2.2"]-->E E["package sdk code"]-->F F["build code"]-->G G["run test"] From dbd896bc9a795bcb3ec7db0a340b517fd3059620 Mon Sep 17 00:00:00 2001 From: JainRah <108508612+JainRah@users.noreply.github.com> Date: Fri, 12 May 2023 06:19:21 +0530 Subject: [PATCH 63/79] Fixed double header issue (#23895) --- .../2022-11-01/examples/NetworkVirtualAppliancePut.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2022-11-01/examples/NetworkVirtualAppliancePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2022-11-01/examples/NetworkVirtualAppliancePut.json index c4a7afda3ebb..e4d5c643eeb4 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2022-11-01/examples/NetworkVirtualAppliancePut.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2022-11-01/examples/NetworkVirtualAppliancePut.json @@ -110,9 +110,7 @@ }, "201": { "headers": { - "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=2022-11-01" - } + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Network/locations/westus/nfvOperations/00000000-0000-0000-0000-000000000000?api-version=2022-11-01" }, "body": { "name": "nva", From 99dad1e94c408d931172e35eef941e76837a6d76 Mon Sep 17 00:00:00 2001 From: Vaibhavi-Mishra <88141876+Vaibhavi-Mishra@users.noreply.github.com> Date: Fri, 12 May 2023 06:42:04 +0530 Subject: [PATCH 64/79] [Hub Generated] Publish private branch 'vaibmishra/onboardStorageResource' (#23901) * onboarding storage resource * addressing failures from automated checks * onboarding as a new resource provider instead of resoruce type * addressing the checks * addressign check fails x2 * addressing check fails x3 * resource onboarding in the same rp * checks fail x1 * prettier fix * swagger model validation check * fix the pattern change * support put, list, patch, delete api calls * address checks x1 * put and delete api with 2xx code * addressing check and restructure abmsi * fixing checks again * checks againnnn * fixing PAYG and adding 201 for put * try to fix lintdiff check * check fails * missed this file * fixing the error response * fixing the error response for bmi --- custom-words.txt | 1 + .../2023-04-06/baremetalinfrastructure.json | 1020 +++++++++++++++++ .../examples/AzureBareMetalInstances_Get.json | 55 + ...areMetalInstances_ListByResourceGroup.json | 106 ++ ...BareMetalInstances_ListBySubscription.json | 100 ++ .../AzureBareMetalInstances_PatchTags.json | 63 + ...reBareMetalInstances_PatchTags_Delete.json | 59 + .../AzureBareMetalOperations_List.json | 33 + ...AzureBareMetalStorageInstances_Create.json | 99 ++ ...AzureBareMetalStorageInstances_Delete.json | 12 + .../AzureBareMetalStorageInstances_Get.json | 44 + ...lStorageInstances_ListByResourceGroup.json | 79 ++ ...alStorageInstances_ListBySubscription.json | 78 ++ ...reBareMetalStorageInstances_PatchTags.json | 49 + ...etalStorageInstances_PatchTags_Delete.json | 45 + .../resource-manager/readme.go.md | 11 + .../resource-manager/readme.md | 11 +- .../resource-manager/readme.ruby.md | 12 +- 18 files changed, 1875 insertions(+), 2 deletions(-) create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_Get.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_ListByResourceGroup.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_ListBySubscription.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_PatchTags.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_PatchTags_Delete.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalOperations_List.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Create.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Delete.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Get.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_ListByResourceGroup.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_ListBySubscription.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_PatchTags.json create mode 100644 specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_PatchTags_Delete.json diff --git a/custom-words.txt b/custom-words.txt index 9bb7e88f4e12..443b6f6939fe 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -259,6 +259,7 @@ Baidu bangla baremetal baremetalinfrastructure +baremetalstorage batchmanaged batchresponse BAYESIANOPTIMIZATION diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json new file mode 100644 index 000000000000..684dde3149bd --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json @@ -0,0 +1,1020 @@ +{ + "swagger": "2.0", + "info": { + "version": "2023-04-06", + "title": "bareMetalInfrastructureClient", + "description": "The BareMetalInfrastructure Management client" + }, + "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.BareMetalInfrastructure/bareMetalInstances": { + "get": { + "tags": [ + "BareMetalInfrastructure" + ], + "operationId": "AzureBareMetalInstances_ListBySubscription", + "summary": "Gets a list of Azure BareMetal instances in the specified subscription.", + "description": "Gets a list of AzureBareMetal instances in the specified subscription. The operations returns various properties of each Azure BareMetal instance.", + "x-ms-examples": { + "List all AzureBareMetal instances in a subscription": { + "$ref": "./examples/AzureBareMetalInstances_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances": { + "get": { + "operationId": "AzureBareMetalInstances_ListByResourceGroup", + "summary": "Gets a list of Azure BareMetal instances in the specified subscription and resource group.", + "description": "Gets a list of AzureBareMetal instances in the specified subscription and resource group. The operations returns various properties of each Azure BareMetal instance.", + "x-ms-examples": { + "List all AzureBareMetal instances in a resource group": { + "$ref": "./examples/AzureBareMetalInstances_ListByResourceGroup.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" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.BareMetalInfrastructure/operations": { + "get": { + "tags": [ + "AzureBareMetal" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "List all management operations supported by the AzureBareMetal RP": { + "$ref": "./examples/AzureBareMetalOperations_List.json" + } + }, + "description": "Gets a list of AzureBareMetal management operations.", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/{azureBareMetalInstanceName}": { + "get": { + "tags": [ + "BareMetalInfrastructure" + ], + "operationId": "AzureBareMetalInstances_Get", + "summary": "Gets an Azure BareMetal instance.", + "description": "Gets an Azure BareMetal instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Get an AzureBareMetal instance": { + "$ref": "./examples/AzureBareMetalInstances_Get.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/AzureBareMetalInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "BareMetalInfrastructure" + ], + "operationId": "AzureBareMetalInstances_Update", + "summary": "Patches the Tags field of a Azure BareMetal instance.", + "description": "Patches the Tags field of a Azure BareMetal instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Update Tags field of an AzureBareMetal instance": { + "$ref": "./examples/AzureBareMetalInstances_PatchTags.json" + }, + "Delete Tags field of an AzureBareMetal instance": { + "$ref": "./examples/AzureBareMetalInstances_PatchTags_Delete.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/AzureBareMetalInstanceNameParameter" + }, + { + "$ref": "#/parameters/TagsParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances": { + "get": { + "tags": [ + "BareMetalInfrastructure" + ], + "operationId": "AzureBareMetalStorageInstances_ListBySubscription", + "summary": "Gets a list of Azure BareMetalStorage instances in the specified subscription.", + "description": "Gets a list of AzureBareMetalStorage instances in the specified subscription. The operations returns various properties of each Azure BareMetal instance.", + "x-ms-examples": { + "List all AzureBareMetalStorage instances in a subscription": { + "$ref": "./examples/AzureBareMetalStorageInstances_ListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances": { + "get": { + "operationId": "AzureBareMetalStorageInstances_ListByResourceGroup", + "summary": "Gets a list of Azure BareMetalStorage instances in the specified subscription and resource group.", + "description": "Gets a list of AzureBareMetalStorage instances in the specified subscription and resource group. The operations returns various properties of each Azure BareMetal instance.", + "x-ms-examples": { + "List all AzureBareMetalStorage instances in a resource group": { + "$ref": "./examples/AzureBareMetalStorageInstances_ListByResourceGroup.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" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstancesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/{azureBareMetalStorageInstanceName}": { + "get": { + "tags": [ + "BareMetalInfrastructure" + ], + "operationId": "AzureBareMetalStorageInstances_Get", + "summary": "Gets an Azure BareMetal Storage instance.", + "description": "Gets an Azure BareMetal Storage instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Get an AzureBareMetalStorage instance": { + "$ref": "./examples/AzureBareMetalStorageInstances_Get.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/AzureBareMetalStorageInstanceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "BareMetalInfrastructure" + ], + "summary": "Create an azure baremetal storage resource.", + "operationId": "AzureBareMetalStorageInstances_Create", + "x-ms-examples": { + "Put a new AzureBareMetalStorageInstance": { + "$ref": "./examples/AzureBareMetalStorageInstances_Create.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalStorageInstanceNameParameter" + }, + { + "in": "body", + "name": "requestBodyParameters", + "required": true, + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + }, + "description": "request body for put call" + } + ], + "responses": { + "200": { + "description": "Update ok. Successfully create a Azure BareMetalStorage resource.", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + } + }, + "201": { + "description": "Created. The operation was successfully started and will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + } + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "BareMetalInfrastructure" + ], + "operationId": "AzureBareMetalStorageInstances_Update", + "summary": "Patches the Tags field of a Azure BareMetalStorage instance.", + "description": "Patches the Tags field of a Azure BareMetalStorage instance for the specified subscription, resource group, and instance name.", + "x-ms-examples": { + "Update Tags field of an AzureBareMetalStorage instance": { + "$ref": "./examples/AzureBareMetalStorageInstances_PatchTags.json" + }, + "Delete Tags field of an AzureBareMetalStorage instance": { + "$ref": "./examples/AzureBareMetalStorageInstances_PatchTags_Delete.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/AzureBareMetalStorageInstanceNameParameter" + }, + { + "$ref": "#/parameters/TagsParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "BareMetalInfrastructure" + ], + "summary": "Delete an AzureBareMetalStorageInstance.", + "operationId": "AzureBareMetalStorageInstances_Delete", + "x-ms-examples": { + "Delete an AzureBareMetalStorageInstance": { + "$ref": "./examples/AzureBareMetalStorageInstances_Delete.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/AzureBareMetalStorageInstanceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The workspace for Grafana resource is deleted." + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations.", + "schema": { + "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AzureBareMetalInstancesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureBareMetalInstance" + }, + "description": "The list of Azure BareMetal instances." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of AzureBareMetal instances." + } + }, + "description": "The response from the List AzureBareMetal Instances operation." + }, + "AzureBareMetalInstance": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBareMetalInstanceProperties", + "description": "AzureBareMetal instance properties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "AzureBareMetal instance info on Azure (ARM properties and AzureBareMetal properties)" + }, + "AzureBareMetalInstanceProperties": { + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the AzureBareMetal instance." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the AzureBareMetal instance disks." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the AzureBareMetal instance." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network settings for the AzureBareMetal instance." + }, + "azureBareMetalInstanceId": { + "readOnly": true, + "type": "string", + "description": "Specifies the AzureBareMetal instance unique ID." + }, + "powerState": { + "readOnly": true, + "type": "string", + "enum": [ + "starting", + "started", + "stopping", + "stopped", + "restarting", + "unknown" + ], + "x-ms-enum": { + "name": "AzureBareMetalInstancePowerStateEnum", + "modelAsString": true + }, + "description": "Resource power state" + }, + "proximityPlacementGroup": { + "readOnly": true, + "type": "string", + "description": "Resource proximity placement group" + }, + "hwRevision": { + "readOnly": true, + "type": "string", + "description": "Hardware revision of an AzureBareMetal instance" + }, + "partnerNodeId": { + "type": "string", + "description": "ARM ID of another AzureBareMetalInstance that will share a network with this AzureBareMetalInstance" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Migrating" + ], + "x-ms-enum": { + "name": "AzureBareMetalProvisioningStatesEnum", + "modelAsString": true + }, + "description": "State of provisioning of the AzureBareMetalInstance" + } + }, + "description": "Describes the properties of an AzureBareMetal instance." + }, + "HardwareProfile": { + "properties": { + "hardwareType": { + "readOnly": true, + "type": "string", + "enum": [ + "Cisco_UCS", + "HPE" + ], + "x-ms-enum": { + "name": "AzureBareMetalHardwareTypeNamesEnum", + "modelAsString": true + }, + "description": "Name of the hardware type (vendor and/or their product name)" + }, + "azureBareMetalInstanceSize": { + "readOnly": true, + "type": "string", + "enum": [ + "S72m", + "S144m", + "S72", + "S144", + "S192", + "S192m", + "S192xm", + "S96", + "S112", + "S224", + "S224m", + "S224om", + "S224oo", + "S224oom", + "S224ooo", + "S384", + "S384m", + "S384xm", + "S384xxm", + "S448", + "S448m", + "S448om", + "S448oo", + "S448oom", + "S448ooo", + "S576m", + "S576xm", + "S672", + "S672m", + "S672om", + "S672oo", + "S672oom", + "S672ooo", + "S768", + "S768m", + "S768xm", + "S896", + "S896m", + "S896om", + "S896oo", + "S896oom", + "S896ooo", + "S960m" + ], + "x-ms-enum": { + "name": "azureBareMetalInstanceSizeNamesEnum", + "modelAsString": true + }, + "description": "Specifies the AzureBareMetal instance SKU." + } + }, + "description": "Specifies the hardware settings for the AzureBareMetal instance." + }, + "Disk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes." + }, + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Specifies the disk information fo the AzureBareMetal instance" + }, + "StorageProfile": { + "properties": { + "nfsIpAddress": { + "readOnly": true, + "type": "string", + "description": "IP Address to connect to storage." + }, + "osDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/Disk" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "Specifies information about the operating system disk used by baremetal instance." + } + }, + "description": "Specifies the storage settings for the AzureBareMetal instance disks." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the AzureBareMetal instance." + }, + "osType": { + "readOnly": true, + "type": "string", + "description": "This property allows you to specify the type of the OS." + }, + "version": { + "readOnly": true, + "type": "string", + "description": "Specifies version of operating system." + }, + "sshPublicKey": { + "type": "string", + "description": "Specifies the SSH public key used to access the operating system." + } + }, + "description": "Specifies the operating system settings for the AzureBareMetal instance." + }, + "NetworkProfile": { + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/IpAddress" + }, + "x-ms-identifiers": [ + "ipAddress" + ], + "description": "Specifies the network interfaces for the AzureBareMetal instance." + }, + "circuitId": { + "readOnly": true, + "type": "string", + "description": "Specifies the circuit id for connecting to express route." + } + }, + "description": "Specifies the network settings for the AzureBareMetal instance disks." + }, + "IpAddress": { + "properties": { + "ipAddress": { + "type": "string", + "description": "Specifies the IP address of the network interface." + } + }, + "description": "Specifies the IP address of the network interface." + }, + "OperationList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "x-ms-identifiers": [ + "name" + ], + "description": "List of AzureBareMetal operations" + } + }, + "description": "List of AzureBareMetal operations" + }, + "Operation": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the operation being performed on this particular object. This name should match the action name that appears in RBAC / the event service." + }, + "display": { + "$ref": "#/definitions/Display", + "description": "Displayed AzureBareMetal operation information" + }, + "isDataAction": { + "readOnly": true, + "description": "indicates whether an operation is a data action or not.", + "type": "boolean" + } + }, + "description": "AzureBareMetal operation information" + }, + "Result": { + "description": "Sample result definition", + "properties": { + "sampleProperty": { + "type": "string", + "description": "Sample property of type string" + } + } + }, + "Display": { + "type": "object", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "The localized friendly form of the resource provider name." + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "The localized friendly form of the resource type related to this action/operation." + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "The localized friendly name for the operation as shown to the user." + }, + "description": { + "readOnly": true, + "type": "string", + "description": "The localized friendly description for the operation as shown to the user." + } + }, + "description": "Detailed BareMetal operation information" + }, + "AzureBareMetalStorageInstancesListResult": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureBareMetalStorageInstance" + }, + "description": "The list of AzureBareMetalStorage instances.", + "x-ms-identifiers": [] + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of AzureBareMetalStorage instances." + } + }, + "description": "The response from the Get AzureBareMetalStorageInstances operation." + }, + "AzureBareMetalStorageInstance": { + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureBareMetalStorageInstanceProperties", + "description": "AzureBareMetalStorageInstance properties" + }, + "systemData": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData", + "description": "The system metadata relating to this resource." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "AzureBareMetalStorageInstance info on Azure (ARM properties and AzureBareMetalStorage properties)" + }, + "AzureBareMetalStorageInstanceProperties": { + "type": "object", + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": { + "type": "string", + "description": "Specifies the AzureBareMetaStorageInstance unique ID." + }, + "storageProperties": { + "$ref": "#/definitions/StorageProperties", + "description": "Specifies the storage properties for the AzureBareMetalStorage instance." + } + }, + "description": "Describes the properties of an AzureBareMetalStorageInstance." + }, + "StorageProperties": { + "type": "object", + "properties": { + "provisioningState": { + "type": "string", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Failed", + "Succeeded", + "Deleting", + "Canceled", + "Migrating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "description": "State of provisioning of the AzureBareMetalStorageInstance" + }, + "offeringType": { + "type": "string", + "description": "the offering type for which the resource is getting provisioned" + }, + "storageType": { + "type": "string", + "description": "the storage protocol for which the resource is getting provisioned" + }, + "generation": { + "type": "string", + "description": "the kind of storage instance" + }, + "hardwareType": { + "type": "string", + "description": "the hardware type of the storage instance" + }, + "workloadType": { + "type": "string", + "description": "the workload for which the resource is getting provisioned" + }, + "storageBillingProperties": { + "$ref": "#/definitions/StorageBillingProperties", + "description": "the billing related information for the resource" + } + }, + "description": "described the storage properties of the azure baremetalstorage instance" + }, + "StorageBillingProperties": { + "type": "object", + "properties": { + "billingMode": { + "type": "string", + "description": "the billing mode for the storage instance" + }, + "azureBareMetalStorageInstanceSize": { + "type": "string", + "description": "the SKU type that is provisioned" + } + }, + "description": "Describes the billing related details of the AzureBareMetalStorageInstance." + }, + "Tags": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags field of the AzureBareMetal/AzureBareMetaStorage instance." + } + }, + "description": "Tags field of the AzureBareMetal/AzureBareMetaStorage instance." + } + }, + "parameters": { + "AzureBareMetalInstanceNameParameter": { + "name": "azureBareMetalInstanceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Azure BareMetal on Azure instance.", + "x-ms-parameter-location": "method" + }, + "AzureBareMetalStorageInstanceNameParameter": { + "name": "azureBareMetalStorageInstanceName", + "in": "path", + "required": true, + "type": "string", + "pattern": ".*", + "description": "Name of the AzureBareMetalStorage on Azure instance.", + "x-ms-parameter-location": "method" + }, + "TagsParameter": { + "name": "tagsParameter", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Tags" + }, + "description": "Request body that only contains the new Tags field", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_Get.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_Get.json new file mode 100644 index 000000000000..271bdf3922d8 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_Get.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myAzureBareMetalInstance" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myAzureBareMetalInstance", + "location": "westus2", + "name": "myAzureBareMetalInstance", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalInstanceId": "23415635-4d7e-41dc-9598-8194f22c24e1", + "powerState": "restarting", + "hwRevision": "Rev 4.2", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "123.123.123.123" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuits/myCircuitId" + }, + "storageProfile": { + "nfsIpAddress": "123.123.119.123" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SLES 12 SP2", + "version": "12 SP2" + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_ListByResourceGroup.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..a09e50ba6a26 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_ListByResourceGroup.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/azureBareMetalInstances/myAzureBareMetalInstance1", + "name": "myAzureBareMetalInstance1", + "type": "Microsoft.BareMetalInfrastructure/azureBareMetalInstances", + "location": "westus", + "tags": { + "key": "value" + }, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalInstanceId": "23415635-4d7e-41dc-9598-8194f22c24e1", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName1", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/azureBareMetalInstances/myABMInstance2", + "name": "myABMInstance2", + "type": "Microsoft.BareMetalInfrastructure/azureBareMetalInstances", + "location": "westus", + "tags": { + "key": "value" + }, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-21T08:01:22.0000000Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-13T08:01:22.1234567Z" + }, + "properties": { + "azureBareMetalInstanceId": "589bce49-9fe6-4dc8-82df-cf6ae25e0cb9", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "HPE", + "azureBareMetalInstanceSize": "S384" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.101" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.201" + }, + "osProfile": { + "computerName": "myComputerName2", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "partnerNodeId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/azureBareMetalInstances/myAzureBareMetalInstance1", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_ListBySubscription.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_ListBySubscription.json new file mode 100644 index 000000000000..202a4e3c1d65 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_ListBySubscription.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/57d3422f-467a-448e-b798-ebf490849542/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myAzureBareMetalInstance1", + "location": "westus2", + "name": "myAzureBareMetalInstance1", + "tags": { + "key": "value" + }, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-21T08:01:22.0000000Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-13T08:01:22.1234567Z" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "properties": { + "azureBareMetalInstanceId": "23415635-4d7e-41dc-9598-8194f22c24e1", + "powerState": "restarting", + "hwRevision": "Rev 4.2", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "123.123.123.123" + } + ], + "circuitId": "/subscriptions/57d3422f-467a-448e-b798-ebf490849542/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuits/myCircuitId" + }, + "storageProfile": { + "nfsIpAddress": "123.123.119.123" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SLES 12 SP2", + "version": "12 SP2" + }, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myAzureBareMetalInstance2", + "location": "westus2", + "name": "myAzureBareMetalInstance2", + "tags": { + "key": "value" + }, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-21T08:01:22.0000000Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-13T08:01:22.1234567Z" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "properties": { + "azureBareMetalInstanceId": "589bce49-9fe6-4dc8-82df-cf6ae25e0cb9", + "powerState": "restarting", + "hwRevision": "Rev 4.2", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "123.123.123.123" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuits/myCircuitId" + }, + "storageProfile": { + "nfsIpAddress": "123.123.119.123" + }, + "osProfile": { + "computerName": "myComputerName2", + "osType": "SLES 12 SP2", + "version": "12 SP2" + }, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_PatchTags.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_PatchTags.json new file mode 100644 index 000000000000..6ef20d5e9989 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_PatchTags.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance", + "tagsParameter": { + "tags": { + "testkey": "testvalue" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance", + "name": "myABMInstance", + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "location": "westus", + "tags": { + "testkey": "testvalue" + }, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalInstanceId": "23415635-4d7e-41dc-9598-8194f22c24e1", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "partnerNodeId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance2", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_PatchTags_Delete.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_PatchTags_Delete.json new file mode 100644 index 000000000000..4dc6f4b76fba --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalInstances_PatchTags_Delete.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalInstanceName": "myABMInstance", + "tagsParameter": { + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance", + "name": "myABMInstance", + "type": "Microsoft.BareMetalInfrastructure/bareMetalInstances", + "location": "westus", + "tags": {}, + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalInstanceId": "23415635-4d7e-41dc-9598-8194f22c24e1", + "powerState": "started", + "proximityPlacementGroup": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myplacementgroup", + "hwRevision": "Rev 3", + "hardwareProfile": { + "hardwareType": "Cisco_UCS", + "azureBareMetalInstanceSize": "S72" + }, + "networkProfile": { + "networkInterfaces": [ + { + "ipAddress": "100.100.100.100" + } + ], + "circuitId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.Network/expressRouteCircuit" + }, + "storageProfile": { + "nfsIpAddress": "200.200.200.200" + }, + "osProfile": { + "computerName": "myComputerName", + "osType": "SUSE", + "version": "12 SP1", + "sshPublicKey": "AAAAB3NzaC1yc2EAAAABJQAAAQB/nAmOjTmezNUDKYvEeIRf2YnwM9/uUG1d0BYsc8/tRtx+RGi7N2lUbp728MXGwdnL9od4cItzky/zVdLZE2cycOa18xBK9cOWmcKS0A8FYBxEQWJ/q9YVUgZbFKfYGaGQxsER+A0w/fX8ALuk78ktP31K69LcQgxIsl7rNzxsoOQKJ/CIxOGMMxczYTiEoLvQhapFQMs3FL96didKr/QbrfB1WT6s3838SEaXfgZvLef1YB2xmfhbT9OXFE3FXvh2UPBfN+ffE7iiayQf/2XR+8j4N4bW30DiPtOQLGUrH1y5X/rpNZNlWW2+jGIxqZtgWg7lTy3mXy5x836Sj/6L" + }, + "partnerNodeId": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalInstances/myABMInstance2", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalOperations_List.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalOperations_List.json new file mode 100644 index 000000000000..18dcdd96fd0e --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalOperations_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2023-04-06" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AzureBareMetalOp1", + "display": { + "provider": "AzureBareMetalOp1ProviderName", + "resource": "AzureBareMetalOp1ResourceName", + "operation": "AzureBareMetalOp1OperationName", + "description": "AzureBareMetalOp1Description" + }, + "isDataAction": false + }, + { + "name": "AzureBareMetalOp2", + "display": { + "provider": "AzureBareMetalOp2ProviderName", + "resource": "AzureBareMetalOp2ResourceName", + "operation": "AzureBareMetalOp2OperationName", + "description": "AzureBareMetalOp2Description" + }, + "isDataAction": true + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Create.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Create.json new file mode 100644 index 000000000000..de25b8aca319 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Create.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalStorageInstanceName": "myAzureBareMetalStorageInstance", + "requestBodyParameters": { + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + }, + "tags": { + "key": "value" + }, + "location": "westus2" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Delete.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Delete.json new file mode 100644 index 000000000000..adce3f3b9baa --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "azureBareMetalStorageInstanceName": "myAzureBareMetalStorageInstance" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Get.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Get.json new file mode 100644 index 000000000000..d80ad518f7b5 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_Get.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalStorageInstanceName": "myAzureBareMetalStorageInstance" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_ListByResourceGroup.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_ListByResourceGroup.json new file mode 100644 index 000000000000..6d797cd37c42 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_ListByResourceGroup.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance1", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance1", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + } + }, + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance2", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance2", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-21T08:01:22.0000000Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-13T08:01:22.1234567Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24f7", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "NFS", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "Cogito", + "storageBillingProperties": { + "billingMode": "RI", + "azureBareMetalStorageInstanceSize": "" + } + } + } + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_ListBySubscription.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_ListBySubscription.json new file mode 100644 index 000000000000..937a7066a0c4 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_ListBySubscription.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance1", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance1", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + } + }, + { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance2", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance2", + "tags": { + "key": "value" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2021-07-21T08:01:22.0000000Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-08-13T08:01:22.1234567Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24f7", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "NFS", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "Cogito", + "storageBillingProperties": { + "billingMode": "RI", + "azureBareMetalStorageInstanceSize": "" + } + } + } + } + ] + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_PatchTags.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_PatchTags.json new file mode 100644 index 000000000000..cc6cfc06a7dd --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_PatchTags.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalStorageInstanceName": "myABMSInstance", + "tagsParameter": { + "tags": { + "testkey": "testvalue" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance", + "tags": { + "testkey": "testvalue" + }, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_PatchTags_Delete.json b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_PatchTags_Delete.json new file mode 100644 index 000000000000..8f3c2ff250e3 --- /dev/null +++ b/specification/baremetalinfrastructure/resource-manager/Microsoft.BareMetalInfrastructure/stable/2023-04-06/examples/AzureBareMetalStorageInstances_PatchTags_Delete.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2023-04-06", + "subscriptionId": "f0f4887f-d13c-4943-a8ba-d7da28d2a3fd", + "resourceGroupName": "myResourceGroup", + "azureBareMetalStorageInstanceName": "myABMSInstance", + "tagsParameter": { + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/f0f4887f-d13c-4943-a8ba-d7da28d2a3fd/resourceGroups/myResourceGroup/providers/Microsoft.BareMetalInfrastructure/bareMetalStorageInstances/myAzureBareMetalStorageInstance", + "location": "westus2", + "name": "myAzureBareMetalStorageInstance", + "tags": {}, + "type": "Microsoft.BareMetalInfrastructure/bareMetalStorageInstances", + "systemData": { + "createdBy": "user@microsoft.com", + "createdByType": "User", + "createdAt": "2020-12-20T23:10:22.6828621Z", + "lastModifiedBy": "user@microsoft.com", + "lastModifiedByType": "User", + "lastModifiedAt": "2021-07-21T08:01:22.0000000Z" + }, + "properties": { + "azureBareMetalStorageInstanceUniqueIdentifier": "23415635-4d7e-41dc-9598-8194f22c24e9", + "storageProperties": { + "provisioningState": "Succeeded", + "offeringType": "EPIC", + "storageType": "FC", + "generation": "Gen4", + "hardwareType": "NetApp", + "workloadType": "ODB", + "storageBillingProperties": { + "billingMode": "PAYG", + "azureBareMetalStorageInstanceSize": "" + } + } + } + } + } + } +} diff --git a/specification/baremetalinfrastructure/resource-manager/readme.go.md b/specification/baremetalinfrastructure/resource-manager/readme.go.md index f4d94fa85945..160807e08dd6 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.go.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.go.md @@ -21,10 +21,21 @@ azure-arm: true ``` yaml $(go) && $(multiapi) batch: + - tag: package-2023-04-06 - tag: package-2021-08-09 - tag: package-2020-08-06-preview ``` +### Tag: package-2023-04-06 and go + +These settings apply only when `--tag=package-2023-04-06 --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2023-04-06' && $(go) +namespace: baremetalinfrastructure +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2023-04-06/$(namespace) +``` + ### Tag: package-2021-08-09 and go These settings apply only when `--tag=package-2021-08-09 --go` is specified on the command line. diff --git a/specification/baremetalinfrastructure/resource-manager/readme.md b/specification/baremetalinfrastructure/resource-manager/readme.md index bdfa9a49815f..3255a8138566 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the BareMetalInfrastructure API. ```yaml openapi-type: arm -tag: package-2021-08-09 +tag: package-2023-04-06 +``` + +### Tag: package-2023-04-06 + +These settings apply only when `--tag=package-2023-04-06` is specified on the command line. + +```yaml $(tag) == 'package-2023-04-06' +input-file: + - Microsoft.BareMetalInfrastructure/stable/2023-04-06/baremetalinfrastructure.json ``` ### Tag: package-2021-08-09 diff --git a/specification/baremetalinfrastructure/resource-manager/readme.ruby.md b/specification/baremetalinfrastructure/resource-manager/readme.ruby.md index 664560a6c594..ef3dd168c631 100644 --- a/specification/baremetalinfrastructure/resource-manager/readme.ruby.md +++ b/specification/baremetalinfrastructure/resource-manager/readme.ruby.md @@ -4,10 +4,20 @@ These settings apply only when `--ruby` is specified on the command line. ```yaml package-name: azure_mgmt_baremetalinfrastructure -package-version: 2021-08-09 +package-version: 2023-04-06 azure-arm: true ``` +### Tag: package-2023-04-06 and ruby + +These settings apply only when `--tag=package-2023-04-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2023-04-06' && $(ruby) +namespace: Microsoft.BareMetalInfrastructure +output-folder: $(ruby-sdks-folder)/baremetalinfrastructure +``` + ### Tag: package-2021-08-09 and ruby These settings apply only when `--tag=package-2021-08-09 --ruby` is specified on the command line. From 1c3433247689aa55d7ecdd213505dc28c035f2b9 Mon Sep 17 00:00:00 2001 From: Sasank Chaganty <29584051+sasank-chaganty@users.noreply.github.com> Date: Thu, 11 May 2023 19:30:45 -0700 Subject: [PATCH 65/79] removing API version (#23821) * removing API version * removing references to 2023-03-15-preview --- .../activeDirectoryConnectors.json | 242 -- .../2023-03-15-preview/azurearcdata.json | 1941 ----------------- .../preview/2023-03-15-preview/common.json | 146 -- .../2023-03-15-preview/dataControllers.json | 253 --- ...reateOrUpdateActiveDirectoryConnector.json | 134 -- ...UpdateArcSqlAvailabilityGroupDatabase.json | 86 - ...rUpdateArcSqlAvailabilityGroupReplica.json | 90 - ...OrUpdateArcSqlServerAvailabilityGroup.json | 90 - .../CreateOrUpdateArcSqlServerDatabase.json | 84 - .../CreateOrUpdateDataController.json | 166 -- .../examples/CreateOrUpdateFailoverGroup.json | 74 - .../CreateOrUpdatePostgresInstance.json | 172 -- .../CreateOrUpdateSqlAvailabilityGroup.json | 96 - .../CreateOrUpdateSqlManagedInstance.json | 192 -- .../CreateOrUpdateSqlServerInstance.json | 112 - .../DeleteActiveDirectoryConnector.json | 26 - ...DeleteArcSqlAvailabilityGroupDatabase.json | 21 - .../DeleteArcSqlAvailabilityGroupReplica.json | 21 - .../DeleteArcSqlServerAvailabilityGroup.json | 21 - .../examples/DeleteArcSqlServerDatabase.json | 21 - .../examples/DeleteDataController.json | 25 - .../examples/DeleteFailoverGroup.json | 18 - .../examples/DeletePostgresInstance.json | 25 - .../examples/DeleteSqlAvailabilityGroup.json | 25 - .../examples/DeleteSqlManagedInstance.json | 25 - .../examples/DeleteSqlServerInstance.json | 25 - .../examples/GetActiveDirectoryConnector.json | 57 - .../GetArcSqlAvailabilityGroupDatabase.json | 47 - .../GetArcSqlAvailabilityGroupReplica.json | 57 - .../GetArcSqlServerAvailabilityGroup.json | 57 - .../examples/GetArcSqlServerDatabase.json | 54 - .../examples/GetDataController.json | 65 - .../examples/GetFailoverGroup.json | 38 - .../examples/GetPostgresInstance.json | 43 - .../examples/GetSqlAvailabilityGroup.json | 43 - .../examples/GetSqlManagedInstance.json | 74 - .../examples/GetSqlServerInstance.json | 49 - ...ataControllerActiveDirectoryConnector.json | 104 - .../ListByResourceGroupDataController.json | 115 - .../ListByResourceGroupPostgresInstance.json | 77 - ...stByResourceGroupSqlAvailabilityGroup.json | 77 - ...ListByResourceGroupSqlManagedInstance.json | 137 -- .../ListByResourceGroupSqlServerInstance.json | 88 - .../ListBySqlAvailabilityGroupDatabase.json | 100 - .../ListBySqlAvailabilityGroupReplica.json | 104 - ...ListBySqlManagedInstanceFailoverGroup.json | 66 - ...tBySqlServerInstanceAvailabilityGroup.json | 104 - .../ListBySqlServerInstanceDatabase.json | 98 - .../examples/ListOperation.json | 353 --- .../ListSubscriptionDataController.json | 119 - .../ListSubscriptionPostgresInstance.json | 76 - .../ListSubscriptionSqlAvailabilityGroup.json | 76 - .../ListSubscriptionSqlManagedInstance.json | 138 -- .../ListSubscriptionSqlServerInstance.json | 87 - .../examples/UpdateDataController.json | 75 - .../examples/UpdatePostgresInstance.json | 48 - .../examples/UpdateSqlAvailabilityGroup.json | 48 - .../UpdateSqlAvailabilityGroupDatabase.json | 85 - .../UpdateSqlAvailabilityGroupReplica.json | 62 - .../examples/UpdateSqlManagedInstance.json | 76 - .../UpdateSqlServerAvailabilityGroup.json | 62 - .../examples/UpdateSqlServerDatabase.json | 59 - .../examples/UpdateSqlServerInstance.json | 54 - .../2023-03-15-preview/failoverGroups.json | 157 -- .../2023-03-15-preview/operations.json | 127 -- .../2023-03-15-preview/postgresInstances.json | 174 -- .../sqlAvailabilityGroups.json | 141 -- .../sqlManagedInstances.json | 307 --- .../sqlServerAvailabilityGroups.json | 1188 ---------- .../sqlServerDatabases.json | 490 ----- .../sqlServerInstances.json | 246 --- .../azurearcdata/resource-manager/readme.md | 22 +- 72 files changed, 1 insertion(+), 10054 deletions(-) delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/activeDirectoryConnectors.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/azurearcdata.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/common.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/dataControllers.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateActiveDirectoryConnector.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlAvailabilityGroupDatabase.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlAvailabilityGroupReplica.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlServerDatabase.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateDataController.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateFailoverGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdatePostgresInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlManagedInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlServerInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteActiveDirectoryConnector.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlAvailabilityGroupDatabase.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlAvailabilityGroupReplica.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlServerAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlServerDatabase.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteDataController.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteFailoverGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeletePostgresInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlManagedInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlServerInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetActiveDirectoryConnector.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlAvailabilityGroupDatabase.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlAvailabilityGroupReplica.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlServerAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlServerDatabase.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetDataController.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetFailoverGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetPostgresInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlManagedInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlServerInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByDataControllerActiveDirectoryConnector.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupDataController.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupPostgresInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlManagedInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlServerInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlAvailabilityGroupDatabase.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlAvailabilityGroupReplica.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlManagedInstanceFailoverGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlServerInstanceDatabase.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListOperation.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionDataController.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionPostgresInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlManagedInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlServerInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateDataController.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdatePostgresInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroupDatabase.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroupReplica.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlManagedInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerAvailabilityGroup.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerDatabase.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerInstance.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/failoverGroups.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/operations.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/postgresInstances.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlAvailabilityGroups.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlManagedInstances.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerAvailabilityGroups.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerDatabases.json delete mode 100644 specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerInstances.json diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/activeDirectoryConnectors.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/activeDirectoryConnectors.json deleted file mode 100644 index d90a0270b510..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/activeDirectoryConnectors.json +++ /dev/null @@ -1,242 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "paths": {}, - "definitions": { - "ActiveDirectoryConnectorListResult": { - "description": "A list of active directory connectors", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/ActiveDirectoryConnectorResource" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "ActiveDirectoryConnectorResource": { - "type": "object", - "description": "Active directory connector resource", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/ActiveDirectoryConnectorProperties", - "description": "null", - "x-ms-client-flatten": false - } - }, - "required": [ - "properties" - ] - }, - "ActiveDirectoryConnectorProperties": { - "type": "object", - "description": "The properties of an Active Directory connector resource", - "properties": { - "domainServiceAccountLoginInformation": { - "$ref": "./common.json#/definitions/BasicLoginInformation", - "description": "Username and password for domain service account authentication." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the Active Directory connector resource.", - "readOnly": true - }, - "spec": { - "$ref": "#/definitions/ActiveDirectoryConnectorSpec", - "description": "null", - "x-ms-client-flatten": false - }, - "status": { - "$ref": "#/definitions/ActiveDirectoryConnectorStatus", - "description": "null", - "x-ms-client-flatten": false - } - }, - "required": [ - "spec" - ] - }, - "ActiveDirectoryConnectorSpec": { - "description": "The specifications of the AD Kubernetes resource.", - "type": "object", - "properties": { - "activeDirectory": { - "$ref": "#/definitions/ActiveDirectoryConnectorDomainDetails", - "description": "null", - "x-ms-client-flatten": false - }, - "dns": { - "$ref": "#/definitions/ActiveDirectoryConnectorDNSDetails", - "description": "null", - "x-ms-client-flatten": false - } - }, - "required": [ - "activeDirectory", - "dns" - ] - }, - "ActiveDirectoryConnectorDomainDetails": { - "type": "object", - "description": "Active Directory domain details", - "properties": { - "realm": { - "type": "string", - "description": "Name (uppercase) of the Active Directory domain that this AD connector will be associated with." - }, - "netbiosDomainName": { - "type": "string", - "description": "NETBIOS name of the Active Directory domain." - }, - "serviceAccountProvisioning": { - "type": "string", - "enum": [ - "automatic", - "manual" - ], - "x-ms-enum": { - "name": "accountProvisioningMode", - "modelAsString": true - }, - "default": "manual", - "description": "The service account provisioning mode for this Active Directory connector." - }, - "ouDistinguishedName": { - "type": "string", - "description": "The distinguished name of the Active Directory Organizational Unit." - }, - "domainControllers": { - "$ref": "#/definitions/ActiveDirectoryDomainControllers", - "description": "null", - "x-ms-client-flatten": false - } - }, - "required": [ - "realm" - ] - }, - "ActiveDirectoryConnectorDNSDetails": { - "type": "object", - "description": "DNS server details", - "properties": { - "domainName": { - "type": "string", - "description": "DNS domain name for which DNS lookups should be forwarded to the Active Directory DNS servers." - }, - "nameserverIPAddresses": { - "type": "array", - "description": "List of Active Directory DNS server IP addresses.", - "items": { - "type": "string", - "minimum": 1 - } - }, - "replicas": { - "type": "integer", - "description": "Replica count for DNS proxy service. Default value is 1.", - "default": 1, - "format": "int64" - }, - "preferK8sDnsForPtrLookups": { - "type": "boolean", - "description": "Flag indicating whether to prefer Kubernetes DNS server response over AD DNS server response for IP address lookups.", - "default": true - } - }, - "required": [ - "nameserverIPAddresses" - ] - }, - "ActiveDirectoryDomainControllers": { - "type": "object", - "description": "Details about the Active Directory domain controllers associated with this AD connector instance", - "properties": { - "primaryDomainController": { - "$ref": "#/definitions/ActiveDirectoryDomainController", - "description": "Information about the Primary Domain Controller (PDC) in the AD domain.", - "x-ms-client-flatten": false - }, - "secondaryDomainControllers": { - "$ref": "#/definitions/ActiveDirectorySecondaryDomainControllers", - "description": "null", - "x-ms-client-flatten": false - } - } - }, - "ActiveDirectoryDomainController": { - "type": "object", - "description": "Information about a domain controller in the AD domain.", - "properties": { - "hostname": { - "type": "string", - "description": "Fully-qualified domain name of a domain controller in the AD domain." - } - }, - "required": [ - "hostname" - ] - }, - "ActiveDirectorySecondaryDomainControllers": { - "type": "array", - "description": "Information about the secondary domain controllers in the AD domain.", - "items": { - "$ref": "#/definitions/ActiveDirectoryDomainController", - "description": "List of the fully-qualified domain names of the secondary domain controllers in the AD domain.", - "x-ms-client-flatten": false - }, - "x-ms-identifiers": [ - "hostname" - ] - }, - "ActiveDirectoryConnectorStatus": { - "type": "object", - "description": "The status of the Kubernetes custom resource.", - "properties": { - "lastUpdateTime": { - "type": "string", - "description": "The time that the custom resource was last updated." - }, - "observedGeneration": { - "type": "integer", - "format": "int64", - "description": "The version of the replicaSet associated with the AD connector custom resource." - }, - "state": { - "type": "string", - "description": "The state of the AD connector custom resource." - } - }, - "additionalProperties": { - "type": "object" - } - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/azurearcdata.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/azurearcdata.json deleted file mode 100644 index 67611403b94c..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/azurearcdata.json +++ /dev/null @@ -1,1941 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/providers/Microsoft.AzureArcData/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available Azure Data Services on Azure Arc API operations.", - "operationId": "Operations_List", - "parameters": [ - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved operations.", - "schema": { - "$ref": "./operations.json#/definitions/OperationListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 400 RPGenericUser - User Failure when calling other Resource Provider.\n\n * 400 InvalidArgument - Invalid argument '{0}'.\n\n * 400 ArgumentNotInRange - Argument '{0}' not in range.\n\n * 400 ResourceNotProvisioned - As the resource: {0} is not in a provisioned state, the request cannot be proceeded forward\n\n * 400 InvalidRgResourceId - Invalid Resourcegroup resource id specified.\n\n * 403 AccessDenied - Access denied.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 SubscriptionDoesNotExist - Subscription id does not exist.\n\n * 404 ResourceDoesNotExist - Resource does not exist.\n\n * 404 OperationIdNotFound - Operation id could not be found.\n\n * 404 OperationTypeNotFound - Operation Type not found.\n\n * 409 ResourceAlreadyExists - Resource already exists.\n\n * 409 SqlExtensionNotInstalled - SQL extension not installed.\n\n * 409 MissingMoveResources - Cannot move resources(s) because some resources are missing in the request.\n\n * 409 OperationInProgress - Operation in progress on resource already.\n\n * 409 OperationCanceled - Operation Cancelled.\n\n * 500 RPGenericSystem - System Failure when calling other Resource Provider.\n\n * 500 UnExpectedErrorOccurred - Unexpected error occurred.\n\n * 500 OperationTimeout - Operation timed out.", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Lists all of the available Azure Data Services on Azure Arc API operations.": { - "$ref": "./examples/ListOperation.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlManagedInstances": { - "get": { - "tags": [ - "SqlManagedInstances" - ], - "operationId": "SqlManagedInstances_List", - "summary": "List sqlManagedInstance resources in the subscription", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL Instance in a subscription.": { - "$ref": "./examples/ListSubscriptionSqlManagedInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances": { - "get": { - "tags": [ - "SqlManagedInstances" - ], - "operationId": "SqlManagedInstances_ListByResourceGroup", - "description": "Gets all sqlManagedInstances in a resource group.", - "summary": "List sqlManagedInstance resources in the resource group", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceListResult" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL Instance in a resource group.": { - "$ref": "./examples/ListByResourceGroupSqlManagedInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}": { - "get": { - "tags": [ - "SqlManagedInstances" - ], - "operationId": "SqlManagedInstances_Get", - "description": "Retrieves a SQL Managed Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlManagedInstanceName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Updates a SQL Instance tags.": { - "$ref": "./examples/GetSqlManagedInstance.json" - } - } - }, - "put": { - "tags": [ - "SqlManagedInstances" - ], - "operationId": "SqlManagedInstances_Create", - "description": "Creates or replaces a SQL Managed Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlManagedInstanceName" - }, - { - "name": "sqlManagedInstance", - "in": "body", - "description": "The SQL Managed Instance to be created or updated.", - "required": true, - "schema": { - "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create or update a SQL Managed Instance": { - "$ref": "./examples/CreateOrUpdateSqlManagedInstance.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "tags": [ - "SqlManagedInstances" - ], - "operationId": "SqlManagedInstances_Delete", - "description": "Deletes a SQL Managed Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlManagedInstanceName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the SQL Managed Instance." - }, - "202": { - "description": "Resource deletion is in progress." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - }, - "204": { - "description": "The specified SQL Managed Instance does not exist." - } - }, - "x-ms-examples": { - "Delete a SQL Instance.": { - "$ref": "./examples/DeleteSqlManagedInstance.json" - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "SqlManagedInstances" - ], - "operationId": "SqlManagedInstances_Update", - "description": "Updates a SQL Managed Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlManagedInstanceName" - }, - { - "name": "parameters", - "in": "body", - "description": "The SQL Managed Instance.", - "required": true, - "schema": { - "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstanceUpdate" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlManagedInstances.json#/definitions/SqlManagedInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Updates a sql Instance tags.": { - "$ref": "./examples/UpdateSqlManagedInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups": { - "get": { - "tags": [ - "FailoverGroups" - ], - "operationId": "FailoverGroups_List", - "summary": "List the failover groups associated with the given sql managed instance.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlManagedInstanceName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./failoverGroups.json#/definitions/FailoverGroupListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all failover groups associated with a sql managed instance.": { - "$ref": "./examples/ListBySqlManagedInstanceFailoverGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlManagedInstances/{sqlManagedInstanceName}/failoverGroups/{failoverGroupName}": { - "put": { - "tags": [ - "FailoverGroups" - ], - "operationId": "FailoverGroups_Create", - "description": "Creates or replaces a failover group resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "failoverGroupResource", - "description": "desc", - "required": true, - "in": "body", - "schema": { - "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" - } - }, - { - "$ref": "#/parameters/sqlManagedInstanceName" - }, - { - "$ref": "#/parameters/failoverGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "Create or update a failover group instance.": { - "$ref": "./examples/CreateOrUpdateFailoverGroup.json" - } - } - }, - "delete": { - "tags": [ - "FailoverGroups" - ], - "operationId": "FailoverGroups_Delete", - "description": "Deletes a failover group resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlManagedInstanceName" - }, - { - "$ref": "#/parameters/failoverGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the failover group." - }, - "202": { - "description": "Resource deletion is in progress." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - }, - "204": { - "description": "The specified failover group does not exist." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Deletes a failover group instance.": { - "$ref": "./examples/DeleteFailoverGroup.json" - } - } - }, - "get": { - "tags": [ - "FailoverGroups" - ], - "operationId": "FailoverGroups_Get", - "description": "Retrieves a failover group resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlManagedInstanceName" - }, - { - "$ref": "#/parameters/failoverGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./failoverGroups.json#/definitions/FailoverGroupResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Retrieves a failover group resource.": { - "$ref": "./examples/GetFailoverGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlServerInstances": { - "get": { - "tags": [ - "SqlServerInstances" - ], - "operationId": "SqlServerInstances_List", - "summary": "List sqlServerInstance resources in the subscription", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL Server Instance in a subscription.": { - "$ref": "./examples/ListSubscriptionSqlServerInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances": { - "get": { - "tags": [ - "SqlServerInstances" - ], - "operationId": "SqlServerInstances_ListByResourceGroup", - "description": "Gets all sqlServerInstances in a resource group.", - "summary": "List sqlServerInstance resources in the resource group", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceListResult" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL Server Instance in a resource group.": { - "$ref": "./examples/ListByResourceGroupSqlServerInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}": { - "get": { - "tags": [ - "SqlServerInstances" - ], - "operationId": "SqlServerInstances_Get", - "description": "Retrieves a SQL Server Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Updates a SQL Server Instance tags.": { - "$ref": "./examples/GetSqlServerInstance.json" - } - } - }, - "put": { - "tags": [ - "SqlServerInstances" - ], - "operationId": "SqlServerInstances_Create", - "description": "Creates or replaces a SQL Server Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "name": "sqlServerInstance", - "in": "body", - "description": "The SQL Server Instance to be created or updated.", - "required": true, - "schema": { - "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Updates a SQL Server Instance tags.": { - "$ref": "./examples/CreateOrUpdateSqlServerInstance.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "tags": [ - "SqlServerInstances" - ], - "operationId": "SqlServerInstances_Delete", - "description": "Deletes a SQL Server Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the SQL Server Instance." - }, - "202": { - "description": "Resource deletion is in progress." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - }, - "204": { - "description": "The specified SQL Server Instance does not exist." - } - }, - "x-ms-examples": { - "Delete a SQL Server Instance.": { - "$ref": "./examples/DeleteSqlServerInstance.json" - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "SqlServerInstances" - ], - "operationId": "SqlServerInstances_Update", - "description": "Updates a SQL Server Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "name": "parameters", - "in": "body", - "description": "The SQL Server Instance.", - "required": true, - "schema": { - "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstanceUpdate" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlServerInstances.json#/definitions/SqlServerInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Updates a SQL Server Instance tags.": { - "$ref": "./examples/UpdateSqlServerInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/sqlAvailabilityGroups": { - "get": { - "tags": [ - "sqlAvailabilityGroups" - ], - "operationId": "sqlAvailabilityGroups_List", - "summary": "List sqlAvailabilityGroups resources in the subscription", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlAvailabilityGroups.json#/definitions/SqlAvailabilityGroupListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL Availability Groups in a subscription.": { - "$ref": "./examples/ListSubscriptionSqlAvailabilityGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlAvailabilityGroups": { - "get": { - "tags": [ - "sqlAvailabilityGroups" - ], - "operationId": "sqlAvailabilityGroups_ListByResourceGroup", - "description": "Gets all sqlAvailabilityGroups in a resource group.", - "summary": "List sqlAvailabilityGroups resources in the resource group", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlAvailabilityGroups.json#/definitions/SqlAvailabilityGroupListResult" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL Server Instance in a resource group.": { - "$ref": "./examples/ListByResourceGroupSqlAvailabilityGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/{sqlAvailabilityGroupName}": { - "get": { - "tags": [ - "sqlAvailabilityGroups" - ], - "operationId": "SqlAvailabilityGroups_Get", - "description": "Retrieves a SQL Availability Group resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlAvailabilityGroups.json#/definitions/SqlAvailabilityGroup" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Updates a SQL Server Instance tags.": { - "$ref": "./examples/GetSqlAvailabilityGroup.json" - } - } - }, - "put": { - "tags": [ - "sqlAvailabilityGroups" - ], - "operationId": "SqlAvailabilityGroups_Create", - "description": "Creates or replaces a SQL Availability Group resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "name": "sqlAvailabilityGroup", - "in": "body", - "description": "The SQL Availability Group to be created or updated.", - "required": true, - "schema": { - "$ref": "./sqlAvailabilityGroups.json#/definitions/SqlAvailabilityGroup" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlAvailabilityGroups.json#/definitions/SqlAvailabilityGroup" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "./sqlAvailabilityGroups.json#/definitions/SqlAvailabilityGroup" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Updates a SQL Availability Group tags.": { - "$ref": "./examples/CreateOrUpdateSqlAvailabilityGroup.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "tags": [ - "sqlAvailabilityGroups" - ], - "operationId": "SqlAvailabilityGroups_Delete", - "description": "Deletes a SQL Availability Group resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the SQL Availability Group." - }, - "202": { - "description": "Resource deletion is in progress." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - }, - "204": { - "description": "The specified SQL Availability Group does not exist." - } - }, - "x-ms-examples": { - "Delete a SQL Server Instance.": { - "$ref": "./examples/DeleteSqlAvailabilityGroup.json" - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "sqlAvailabilityGroups" - ], - "operationId": "SqlAvailabilityGroups_Update", - "description": "Updates a SQL Availability Group resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "name": "parameters", - "in": "body", - "description": "The SQL Availability Group.", - "required": true, - "schema": { - "$ref": "./sqlAvailabilityGroups.json#/definitions/SqlAvailabilityGroupUpdate" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./sqlAvailabilityGroups.json#/definitions/SqlAvailabilityGroup" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Updates a SQL Server Instance tags.": { - "$ref": "./examples/UpdateSqlAvailabilityGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/dataControllers": { - "get": { - "tags": [ - "DataControllers" - ], - "operationId": "DataControllers_ListInSubscription", - "summary": "List dataController resources in the subscription", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./dataControllers.json#/definitions/PageOfDataControllerResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all dataControllers in a subscription.": { - "$ref": "./examples/ListSubscriptionDataController.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers": { - "get": { - "tags": [ - "DataControllers" - ], - "operationId": "DataControllers_ListInGroup", - "summary": "List dataController resources in the resource group", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./dataControllers.json#/definitions/PageOfDataControllerResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all dataControllers in a resource group.": { - "$ref": "./examples/ListByResourceGroupDataController.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}": { - "put": { - "tags": [ - "DataControllers" - ], - "operationId": "DataControllers_PutDataController", - "description": "Creates or replaces a dataController resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "dataControllerResource", - "description": "desc", - "required": true, - "in": "body", - "schema": { - "$ref": "./dataControllers.json#/definitions/DataControllerResource" - } - }, - { - "$ref": "#/parameters/dataControllerName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./dataControllers.json#/definitions/DataControllerResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "./dataControllers.json#/definitions/DataControllerResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create or update a Data Controller.": { - "$ref": "./examples/CreateOrUpdateDataController.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "tags": [ - "DataControllers" - ], - "operationId": "DataControllers_DeleteDataController", - "description": "Deletes a dataController resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/dataControllerName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the DataController." - }, - "202": { - "description": "Resource deletion is in progress." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - }, - "204": { - "description": "The specified DataController does not exist." - } - }, - "x-ms-examples": { - "Delete a dataController.": { - "$ref": "./examples/DeleteDataController.json" - } - }, - "x-ms-long-running-operation": true - }, - "get": { - "tags": [ - "DataControllers" - ], - "operationId": "DataControllers_GetDataController", - "description": "Retrieves a dataController resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/dataControllerName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./dataControllers.json#/definitions/DataControllerResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get a data controller.": { - "$ref": "./examples/GetDataController.json" - } - } - }, - "patch": { - "tags": [ - "DataControllers" - ], - "operationId": "DataControllers_PatchDataController", - "description": "Updates a dataController resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/dataControllerName" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "dataControllerResource", - "description": "The update data controller resource", - "required": true, - "in": "body", - "schema": { - "$ref": "./dataControllers.json#/definitions/DataControllerUpdate" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./dataControllers.json#/definitions/DataControllerResource" - } - }, - "202": { - "description": "Resource update is in progress." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Updates a dataController tags.": { - "$ref": "./examples/UpdateDataController.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.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors": { - "get": { - "tags": [ - "ActiveDirectoryConnectors" - ], - "operationId": "ActiveDirectoryConnectors_List", - "summary": "List the active directory connectors associated with the given data controller.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/dataControllerName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all Active Directory connectors associated with a data controller.": { - "$ref": "./examples/ListByDataControllerActiveDirectoryConnector.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/dataControllers/{dataControllerName}/activeDirectoryConnectors/{activeDirectoryConnectorName}": { - "put": { - "tags": [ - "ActiveDirectoryConnectors" - ], - "operationId": "ActiveDirectoryConnectors_Create", - "description": "Creates or replaces an Active Directory connector resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "activeDirectoryConnectorResource", - "description": "desc", - "required": true, - "in": "body", - "schema": { - "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" - } - }, - { - "$ref": "#/parameters/dataControllerName" - }, - { - "$ref": "#/parameters/activeDirectoryConnectorName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "Create or update an Active Directory connector instance.": { - "$ref": "./examples/CreateOrUpdateActiveDirectoryConnector.json" - } - } - }, - "delete": { - "tags": [ - "ActiveDirectoryConnectors" - ], - "operationId": "ActiveDirectoryConnectors_Delete", - "description": "Deletes an Active Directory connector resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/dataControllerName" - }, - { - "$ref": "#/parameters/activeDirectoryConnectorName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the active directory connector." - }, - "202": { - "description": "Resource deletion is in progress." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - }, - "204": { - "description": "The specified active directory connector does not exist." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Deletes an Active Directory connector instance.": { - "$ref": "./examples/DeleteActiveDirectoryConnector.json" - } - } - }, - "get": { - "tags": [ - "ActiveDirectoryConnectors" - ], - "operationId": "ActiveDirectoryConnectors_Get", - "description": "Retrieves an Active Directory connector resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/dataControllerName" - }, - { - "$ref": "#/parameters/activeDirectoryConnectorName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./activeDirectoryConnectors.json#/definitions/ActiveDirectoryConnectorResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Retrieves an Active Directory connector resource.": { - "$ref": "./examples/GetActiveDirectoryConnector.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AzureArcData/postgresInstances": { - "get": { - "tags": [ - "PostgresInstances" - ], - "operationId": "PostgresInstances_List", - "summary": "List postgres Instance resources in the subscription", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./postgresInstances.json#/definitions/PostgresInstanceListResult" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all Postgres Instance in a subscription.": { - "$ref": "./examples/ListSubscriptionPostgresInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances": { - "get": { - "tags": [ - "PostgresInstances" - ], - "operationId": "PostgresInstances_ListByResourceGroup", - "description": "Get a postgres Instances list by Resource group name.", - "summary": "List postgres Instance resources in the resource group", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./postgresInstances.json#/definitions/PostgresInstanceListResult" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all postgres Instances in a resource group.": { - "$ref": "./examples/ListByResourceGroupPostgresInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/postgresInstances/{postgresInstanceName}": { - "get": { - "tags": [ - "PostgresInstances" - ], - "operationId": "PostgresInstances_Get", - "description": "Retrieves a postgres Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/postgresInstanceName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./postgresInstances.json#/definitions/PostgresInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Gets a postgres Instances.": { - "$ref": "./examples/GetPostgresInstance.json" - } - } - }, - "put": { - "tags": [ - "PostgresInstances" - ], - "operationId": "PostgresInstances_Create", - "description": "Creates or replaces a postgres Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/postgresInstanceName" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "resource", - "description": "The postgres instance", - "required": true, - "in": "body", - "schema": { - "$ref": "./postgresInstances.json#/definitions/PostgresInstance" - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./postgresInstances.json#/definitions/PostgresInstance" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "./postgresInstances.json#/definitions/PostgresInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create or update a Postgres Instance.": { - "$ref": "./examples/CreateOrUpdatePostgresInstance.json" - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - } - }, - "delete": { - "tags": [ - "PostgresInstances" - ], - "operationId": "PostgresInstances_Delete", - "description": "Deletes a postgres Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/postgresInstanceName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the Postgres Instance." - }, - "202": { - "description": "Resource deletion is in progress." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - }, - "204": { - "description": "The specified Postgres Instance does not exist." - } - }, - "x-ms-examples": { - "Deletes a PostgresInstances.": { - "$ref": "./examples/DeletePostgresInstance.json" - } - }, - "x-ms-long-running-operation": true - }, - "patch": { - "tags": [ - "PostgresInstances" - ], - "operationId": "PostgresInstances_Update", - "description": "Updates a postgres Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/postgresInstanceName" - }, - { - "name": "parameters", - "in": "body", - "description": "The Postgres Instance.", - "required": true, - "schema": { - "$ref": "./postgresInstances.json#/definitions/PostgresInstanceUpdate" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "./postgresInstances.json#/definitions/PostgresInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Updates a postgres Instances tags.": { - "$ref": "./examples/UpdatePostgresInstance.json" - } - } - } - } - }, - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the Azure subscription", - "x-ms-parameter-location": "client" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Azure resource group", - "x-ms-parameter-location": "method" - }, - "location": { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The Azure region to use for the request", - "x-ms-parameter-location": "method" - }, - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request", - "x-ms-parameter-location": "client" - }, - "dataControllerName": { - "name": "dataControllerName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the data controller", - "x-ms-parameter-location": "method" - }, - "activeDirectoryConnectorName": { - "name": "activeDirectoryConnectorName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Active Directory connector instance", - "x-ms-parameter-location": "method" - }, - "sqlManagedInstanceName": { - "name": "sqlManagedInstanceName", - "description": "Name of SQL Managed Instance", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "failoverGroupName": { - "name": "failoverGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Failover Group", - "x-ms-parameter-location": "method" - }, - "sqlServerInstanceName": { - "name": "sqlServerInstanceName", - "description": "Name of SQL Server Instance", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "sqlAvailabilityGroupName": { - "name": "sqlAvailabilityGroupName", - "description": "Name of SQL Availability Group", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "postgresInstanceName": { - "name": "postgresInstanceName", - "description": "Name of Postgres Instance", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/common.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/common.json deleted file mode 100644 index 901a83091b21..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/common.json +++ /dev/null @@ -1,146 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "paths": {}, - "definitions": { - "CommonSku": { - "description": "The resource model definition representing SKU for ARM resources", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the SKU. It is typically a letter+number code" - }, - "dev": { - "type": "boolean", - "default": true, - "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " - }, - "size": { - "type": "string", - "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " - }, - "family": { - "type": "string", - "description": "If the service has different generations of hardware, for the same SKU, then that can be captured here." - }, - "capacity": { - "type": "integer", - "format": "int32", - "description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted." - } - }, - "required": [ - "name" - ] - }, - "ErrorResponse": { - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/ErrorResponseBody", - "description": "null" - } - }, - "description": "An error response from the Azure Data on Azure Arc service." - }, - "ErrorResponseBody": { - "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/ErrorResponseBody" - }, - "x-ms-identifiers": [ - "message", - "target" - ], - "description": "A list of additional details about the error." - } - }, - "description": "An error response from the Batch service." - }, - "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." - } - } - }, - "ExtendedLocationType": { - "type": "string", - "description": "The type of extendedLocation.", - "enum": [ - "CustomLocation" - ], - "x-ms-enum": { - "name": "ExtendedLocationTypes", - "modelAsString": true - } - }, - "BasicLoginInformation": { - "type": "object", - "description": "Username and password for basic login authentication.", - "properties": { - "username": { - "type": "string", - "description": "Login username." - }, - "password": { - "type": "string", - "description": "Login password.", - "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true - } - } - } - }, - "parameters": { - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request", - "x-ms-parameter-location": "client" - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/dataControllers.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/dataControllers.json deleted file mode 100644 index e963c9ceed84..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/dataControllers.json +++ /dev/null @@ -1,253 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "paths": {}, - "definitions": { - "DataControllerResource": { - "description": "Data controller resource", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "extendedLocation": { - "$ref": "./common.json#/definitions/ExtendedLocation", - "description": "The extendedLocation of the resource." - }, - "properties": { - "$ref": "#/definitions/DataControllerProperties", - "description": "The data controller's properties", - "x-ms-client-flatten": false - } - }, - "required": [ - "properties" - ] - }, - "PageOfDataControllerResource": { - "type": "object", - "description": "A list of data controllers.", - "properties": { - "value": { - "items": { - "$ref": "#/definitions/DataControllerResource" - }, - "type": "array", - "description": "Array of results." - }, - "nextLink": { - "type": "string", - "description": "Link to retrieve next page of results." - } - } - }, - "DataControllerUpdate": { - "type": "object", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Resource tags" - }, - "properties": { - "$ref": "#/definitions/DataControllerProperties", - "description": "The data controller's properties", - "x-ms-client-flatten": false - } - }, - "description": "Used for updating a data controller resource." - }, - "DataControllerProperties": { - "description": "The data controller properties.", - "type": "object", - "properties": { - "infrastructure": { - "type": "string", - "enum": [ - "azure", - "gcp", - "aws", - "alibaba", - "onpremises", - "other" - ], - "x-ms-enum": { - "name": "infrastructure", - "modelAsString": false - }, - "default": "other", - "description": "The infrastructure the data controller is running on." - }, - "onPremiseProperty": { - "$ref": "#/definitions/OnPremiseProperty" - }, - "k8sRaw": { - "type": "object", - "description": "The raw kubernetes information" - }, - "uploadWatermark": { - "$ref": "#/definitions/UploadWatermark" - }, - "lastUploadedDate": { - "type": "string", - "format": "date-time", - "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" - }, - "basicLoginInformation": { - "$ref": "./common.json#/definitions/BasicLoginInformation", - "description": "Deprecated. Azure Arc Data Services data controller no longer expose any endpoint. All traffic are exposed through Kubernetes native API." - }, - "metricsDashboardCredential": { - "$ref": "./common.json#/definitions/BasicLoginInformation", - "description": "Login credential for metrics dashboard on the Kubernetes cluster." - }, - "logsDashboardCredential": { - "$ref": "./common.json#/definitions/BasicLoginInformation", - "description": "Login credential for logs dashboard on the Kubernetes cluster." - }, - "logAnalyticsWorkspaceConfig": { - "$ref": "#/definitions/LogAnalyticsWorkspaceConfig" - }, - "uploadServicePrincipal": { - "$ref": "#/definitions/UploadServicePrincipal", - "description": "Deprecated. Service principal is deprecated in favor of Arc Kubernetes service extension managed identity." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the Arc Data Controller resource.", - "readOnly": true - }, - "clusterId": { - "type": "string", - "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to." - }, - "extensionId": { - "type": "string", - "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to." - } - } - }, - "UploadWatermark": { - "description": "Properties on upload watermark. Mostly timestamp for each upload data type", - "type": "object", - "properties": { - "metrics": { - "type": "string", - "format": "date-time", - "description": "Last uploaded date for metrics from kubernetes cluster. Defaults to current date time" - }, - "logs": { - "type": "string", - "format": "date-time", - "description": "Last uploaded date for logs from kubernetes cluster. Defaults to current date time" - }, - "usages": { - "type": "string", - "format": "date-time", - "description": "Last uploaded date for usages from kubernetes cluster. Defaults to current date time" - } - } - }, - "OnPremiseProperty": { - "description": "Properties from the Kubernetes data controller", - "type": "object", - "properties": { - "id": { - "type": "string", - "format": "uuid", - "description": "A globally unique ID identifying the associated Kubernetes cluster" - }, - "publicSigningKey": { - "type": "string", - "description": "Certificate that contains the Kubernetes cluster public key used to verify signing" - }, - "signingCertificateThumbprint": { - "type": "string", - "description": "Unique thumbprint returned to customer to verify the certificate being uploaded" - } - }, - "required": [ - "id", - "publicSigningKey" - ] - }, - "LogAnalyticsWorkspaceConfig": { - "type": "object", - "description": "Log analytics workspace id and primary key", - "properties": { - "workspaceId": { - "type": "string", - "format": "uuid", - "description": "Azure Log Analytics workspace ID" - }, - "primaryKey": { - "type": "string", - "description": "Primary key of the workspace", - "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true - } - } - }, - "UploadServicePrincipal": { - "type": "object", - "description": "Service principal for uploading billing, metrics and logs.", - "properties": { - "clientId": { - "type": "string", - "format": "uuid", - "description": "Client ID of the service principal for uploading data." - }, - "tenantId": { - "type": "string", - "format": "uuid", - "description": "Tenant ID of the service principal." - }, - "authority": { - "type": "string", - "description": "Authority for the service principal. Example: https://login.microsoftonline.com/" - }, - "clientSecret": { - "type": "string", - "description": "Secret of the service principal", - "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true - } - } - } - }, - "parameters": { - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request", - "x-ms-parameter-location": "client" - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateActiveDirectoryConnector.json deleted file mode 100644 index 0c1eac708ef1..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateActiveDirectoryConnector.json +++ /dev/null @@ -1,134 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "dataControllerName": "testdataController", - "activeDirectoryConnectorName": "testADConnector", - "api-version": "2023-03-15-preview", - "activeDirectoryConnectorResource": { - "properties": { - "spec": { - "activeDirectory": { - "realm": "CONTOSO.LOCAL", - "serviceAccountProvisioning": "manual", - "domainControllers": { - "primaryDomainController": { - "hostname": "dc1.contoso.local" - }, - "secondaryDomainControllers": [ - { - "hostname": "dc2.contoso.local" - }, - { - "hostname": "dc3.contoso.local" - } - ] - } - }, - "dns": { - "nameserverIPAddresses": [ - "11.11.111.111", - "22.22.222.222" - ], - "replicas": 1, - "preferK8sDnsForPtrLookups": false - } - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "spec": { - "activeDirectory": { - "realm": "CONTOSO.LOCAL", - "serviceAccountProvisioning": "manual", - "domainControllers": { - "primaryDomainController": { - "hostname": "dc1.contoso.local" - }, - "secondaryDomainControllers": [ - { - "hostname": "dc2.contoso.local" - }, - { - "hostname": "dc3.contoso.local" - } - ] - }, - "netbiosDomainName": "CONTOSO" - }, - "dns": { - "nameserverIPAddresses": [ - "11.11.111.111", - "22.22.222.222" - ], - "replicas": 1, - "preferK8sDnsForPtrLookups": false, - "domainName": "contoso.local" - } - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", - "name": "testADConnector", - "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" - } - }, - "201": { - "body": { - "properties": { - "spec": { - "activeDirectory": { - "realm": "CONTOSO.LOCAL", - "serviceAccountProvisioning": "manual", - "domainControllers": { - "primaryDomainController": { - "hostname": "dc1.contoso.local" - }, - "secondaryDomainControllers": [ - { - "hostname": "dc2.contoso.local" - }, - { - "hostname": "dc3.contoso.local" - } - ] - }, - "netbiosDomainName": "CONTOSO" - }, - "dns": { - "nameserverIPAddresses": [ - "11.11.111.111", - "22.22.222.222" - ], - "replicas": 1, - "preferK8sDnsForPtrLookups": false, - "domainName": "contoso.local" - } - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", - "name": "testADConnector", - "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlAvailabilityGroupDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlAvailabilityGroupDatabase.json deleted file mode 100644 index 4fb66bd41d20..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlAvailabilityGroupDatabase.json +++ /dev/null @@ -1,86 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlAvailabilityGroupDatabaseName": "testSqlDatabase", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview", - "sqlAvailabilityGroupDatabaseResource": { - "location": "southeastasia", - "tags": { - "mytag": "myval" - }, - "properties": { - "groupDatabaseId": "00000000-1111-2222-3333-444444444444", - "value": [ - { - "replicaName": "sqlServer1", - "isLocal": true, - "isPrimaryReplica": true, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - }, - { - "replicaName": "sqlServer2", - "isLocal": false, - "isPrimaryReplica": false, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsAG/databases/testSqlDatabase", - "name": "testSqlDatabase", - "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/databases", - "properties": { - "groupDatabaseId": "00000000-1111-2222-3333-444444444444", - "value": [ - { - "replicaName": "sqlServer1", - "isLocal": true, - "isPrimaryReplica": true, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - }, - { - "replicaName": "sqlServer2", - "isLocal": false, - "isPrimaryReplica": false, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - } - ] - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlAvailabilityGroupReplica.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlAvailabilityGroupReplica.json deleted file mode 100644 index 62a800ed5fc8..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlAvailabilityGroupReplica.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testSqlServerInstance", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview", - "sqlAvailabilityGroupReplicaResource": { - "location": "southeastasia", - "tags": { - "mytag": "myval" - }, - "properties": { - "replicaId": "00000000-1111-2222-3333-444444444444", - "replicaName": "testSqlServerInstance", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - } - } - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsAG/sqlServerInstances/testSqlServerInstance", - "name": "testSqlServerInstance", - "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/sqlServerInstances", - "properties": { - "replicaId": "00000000-1111-2222-3333-444444444444", - "replicaName": "testSqlServerInstance", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json deleted file mode 100644 index fe6385bbf5cc..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json +++ /dev/null @@ -1,90 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testSqlServerInstance", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview", - "sqlServerAvailabilityGroupResource": { - "location": "southeastasia", - "tags": { - "mytag": "myval" - }, - "properties": { - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "availabilityGroupName": "testAG", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - } - } - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServerInstance/sqlAvailabilityGroups/testAG", - "name": "testAG", - "type": "Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups", - "properties": { - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "availabilityGroupName": "testAG", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlServerDatabase.json deleted file mode 100644 index 49b699558bfd..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateArcSqlServerDatabase.json +++ /dev/null @@ -1,84 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testSqlServerInstance", - "databaseName": "testdb", - "api-version": "2023-03-15-preview", - "sqlServerDatabaseResource": { - "location": "southeastasia", - "tags": { - "mytag": "myval" - }, - "properties": { - "collationName": "SQL_Latin1_General_CP1_CI_AS", - "databaseCreationDate": "2022-04-05T16:26:33.883Z", - "compatibilityLevel": 150, - "state": "Online", - "isReadOnly": true, - "recoveryMode": "Full", - "sizeMB": 150.00, - "spaceAvailableMB": 100.00, - "databaseOptions": { - "isAutoCloseOn": true, - "isAutoShrinkOn": true, - "isAutoCreateStatsOn": true, - "isAutoUpdateStatsOn": true, - "isMemoryOptimizationEnabled": true, - "isRemoteDataArchiveEnabled": true, - "isEncrypted": true, - "isTrustworthyOn": true - }, - "backupInformation": { - "lastFullBackup": "2022-05-05T16:26:33.883Z", - "lastLogBackup": "2022-05-10T16:26:33.883Z" - } - } - } - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", - "name": "testdb", - "type": "Microsoft.AzureArcData/sqlServerInstances/databases", - "properties": { - "collationName": "SQL_Latin1_General_CP1_CI_AS", - "databaseCreationDate": "2022-04-05T16:26:33.883Z", - "compatibilityLevel": 150, - "state": "Online", - "isReadOnly": true, - "recoveryMode": "Full", - "sizeMB": 150.00, - "spaceAvailableMB": 100.00, - "databaseOptions": { - "isAutoCloseOn": true, - "isAutoShrinkOn": true, - "isAutoCreateStatsOn": true, - "isAutoUpdateStatsOn": true, - "isMemoryOptimizationEnabled": true, - "isRemoteDataArchiveEnabled": true, - "isEncrypted": true, - "isTrustworthyOn": true - }, - "backupInformation": { - "lastFullBackup": "2022-05-05T16:26:33.883Z", - "lastLogBackup": "2022-05-10T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateDataController.json deleted file mode 100644 index 747511cb4277..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateDataController.json +++ /dev/null @@ -1,166 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "dataControllerName": "testdataController", - "api-version": "2023-03-15-preview", - "dataControllerResource": { - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "properties": { - "onPremiseProperty": { - "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", - "publicSigningKey": "publicOnPremSigningKey" - }, - "basicLoginInformation": { - "username": "username", - "password": "********" - }, - "metricsDashboardCredential": { - "username": "username", - "password": "********" - }, - "logsDashboardCredential": { - "username": "username", - "password": "********" - }, - "logAnalyticsWorkspaceConfig": { - "workspaceId": "00000000-1111-2222-3333-444444444444", - "primaryKey": "********" - }, - "uploadServicePrincipal": { - "clientId": "00000000-1111-2222-3333-444444444444", - "tenantId": "00000000-1111-2222-3333-444444444444", - "authority": "https://login.microsoftonline.com/", - "clientSecret": "********" - }, - "uploadWatermark": { - "metrics": "2020-01-01T17:18:19.1234567Z", - "logs": "2020-01-01T17:18:19.1234567Z", - "usages": "2020-01-01T17:18:19.1234567Z" - }, - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "infrastructure": "onpremises" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "onPremiseProperty": { - "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", - "publicSigningKey": "publicOnPremSigningKey", - "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" - }, - "basicLoginInformation": { - "username": "username" - }, - "metricsDashboardCredential": { - "username": "username" - }, - "logsDashboardCredential": { - "username": "username" - }, - "logAnalyticsWorkspaceConfig": { - "workspaceId": "00000000-1111-2222-3333-444444444444" - }, - "uploadServicePrincipal": { - "clientId": "00000000-1111-2222-3333-444444444444", - "tenantId": "00000000-1111-2222-3333-444444444444", - "authority": "https://login.microsoftonline.com/" - }, - "uploadWatermark": { - "metrics": "2020-01-01T17:18:19.1234567Z", - "logs": "2020-01-01T17:18:19.1234567Z", - "usages": "2020-01-01T17:18:19.1234567Z" - }, - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "infrastructure": "onpremises" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", - "name": "testdataController", - "type": "Microsoft.AzureArcData/dataControllers" - } - }, - "201": { - "body": { - "properties": { - "onPremiseProperty": { - "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", - "publicSigningKey": "publicOnPremSigningKey", - "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate being uploaded" - }, - "basicLoginInformation": { - "username": "username" - }, - "metricsDashboardCredential": { - "username": "username" - }, - "logsDashboardCredential": { - "username": "username" - }, - "logAnalyticsWorkspaceConfig": { - "workspaceId": "00000000-1111-2222-3333-444444444444" - }, - "uploadServicePrincipal": { - "clientId": "00000000-1111-2222-3333-444444444444", - "tenantId": "00000000-1111-2222-3333-444444444444", - "authority": "https://login.microsoftonline.com/" - }, - "uploadWatermark": { - "metrics": "2020-01-01T17:18:19.1234567Z", - "logs": "2020-01-01T17:18:19.1234567Z", - "usages": "2020-01-01T17:18:19.1234567Z" - }, - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "infrastructure": "onpremises" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", - "name": "testdataController", - "type": "Microsoft.AzureArcData/dataControllers" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateFailoverGroup.json deleted file mode 100644 index 58243daa2069..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateFailoverGroup.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlManagedInstanceName": "testSqlManagedInstance", - "failoverGroupName": "testFailoverGroupName", - "api-version": "2023-03-15-preview", - "failoverGroupResource": { - "properties": { - "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", - "spec": { - "partnerSyncMode": "async", - "role": "primary" - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", - "spec": { - "sharedName": "testSharedName", - "sourceMI": "sourceSQLMI", - "partnerMI": "partnerMI", - "partnerMirroringURL": "11.11.111.111", - "partnerMirroringCert": "testCert", - "partnerSyncMode": "async", - "role": "primary" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", - "name": "testFailoverGroupName", - "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" - } - }, - "201": { - "body": { - "properties": { - "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", - "spec": { - "sharedName": "testSharedName", - "sourceMI": "sourceSQLMI", - "partnerMI": "partnerMI", - "partnerMirroringURL": "11.11.111.111", - "partnerMirroringCert": "testCert", - "partnerSyncMode": "async", - "role": "primary" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", - "name": "testFailoverGroupName", - "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdatePostgresInstance.json deleted file mode 100644 index fcb39f521e6f..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdatePostgresInstance.json +++ /dev/null @@ -1,172 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "postgresInstanceName": "testpostgresInstance", - "api-version": "2023-03-15-preview", - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "resource": { - "location": "eastus", - "properties": { - "dataControllerId": "dataControllerId", - "admin": "admin", - "basicLoginInformation": { - "username": "username", - "password": "********" - }, - "k8sRaw": { - "apiVersion": "apiVersion", - "kind": "postgresql-12", - "metadata": { - "creationTimestamp": "2020-08-25T14:55:10Z", - "generation": 1, - "name": "pg1", - "namespace": "test", - "resourceVersion": "527780", - "selfLink": "/apis/arcdata.microsoft.com/v1alpha1/namespaces/test/postgresql-12s/pg1", - "uid": "1111aaaa-ffff-ffff-ffff-99999aaaaaaa" - }, - "spec": { - "backups": { - "deltaMinutes": 3, - "fullMinutes": 10, - "tiers": [ - { - "retention": { - "maximums": [ - "6", - "512MB" - ], - "minimums": [ - "3" - ] - }, - "storage": { - "volumeSize": "1Gi" - } - } - ] - }, - "engine": { - "extensions": [ - { - "name": "citus" - } - ] - }, - "scale": { - "shards": 3 - }, - "scheduling": { - "default": { - "resources": { - "requests": { - "memory": "256Mi" - } - } - } - }, - "service": { - "type": "NodePort" - }, - "storage": { - "data": { - "className": "local-storage", - "size": "5Gi" - }, - "logs": { - "className": "local-storage", - "size": "5Gi" - } - } - }, - "status": { - "externalEndpoint": null, - "readyPods": "4/4", - "state": "Ready" - } - } - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "sku": { - "name": "default", - "tier": "Hyperscale", - "dev": true - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "basicLoginInformation": { - "username": "username" - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "default", - "tier": "Hyperscale", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", - "name": "testpostgresInstance", - "type": "Microsoft.AzureArcData/PostgresInstance" - } - }, - "201": { - "body": { - "properties": { - "basicLoginInformation": { - "username": "username" - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "default", - "tier": "Hyperscale", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", - "name": "testsqlregistration", - "type": "Microsoft.AzureArcData/PostgresInstance" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlAvailabilityGroup.json deleted file mode 100644 index 1fc43ad466d8..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlAvailabilityGroup.json +++ /dev/null @@ -1,96 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlAvailabilityGroupName": "testsqlAvailabilityGroup", - "api-version": "2023-03-15-preview", - "sqlAvailabilityGroup": { - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "properties": { - "availabilityGroupName": "myAvailabilityGroup", - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "instanceName": "testInstance", - "collectionTimestamp": "2022-05-05T16:26:33.883Z", - "version": 0, - "basicFeatures": false, - "dtcSupport": false, - "dbFailover": true, - "isDistributed": false, - "clusterTypeDesc": "WSFC", - "requiredSynchronizedSecondariesCommit": 0, - "isContained": false - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "availabilityGroupName": "myAvailabilityGroup", - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "instanceName": "testInstance", - "collectionTimestamp": "2022-05-05T16:26:33.883Z", - "version": 0, - "basicFeatures": false, - "dtcSupport": false, - "dbFailover": true, - "isDistributed": false, - "clusterTypeDesc": "WSFC", - "requiredSynchronizedSecondariesCommit": 0, - "isContained": false - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsqlAvailabilityGroup", - "name": "testsqlServerInstance", - "type": "Microsoft.AzureArcData/SqlServerInstances" - } - }, - "201": { - "body": { - "properties": { - "availabilityGroupName": "myAvailabilityGroup", - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "instanceName": "testInstance", - "collectionTimestamp": "2022-05-05T16:26:33.883Z", - "version": 0, - "basicFeatures": false, - "dtcSupport": false, - "dbFailover": true, - "isDistributed": false, - "clusterTypeDesc": "WSFC", - "requiredSynchronizedSecondariesCommit": 0, - "isContained": false - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlAvailabilityGroups/testsqlAvailabilityGroup", - "name": "testsqlAvailabilityGroup", - "type": "Microsoft.AzureArcData/SqlAvailabilityGroups" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlManagedInstance.json deleted file mode 100644 index 5c6724adeb1f..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlManagedInstance.json +++ /dev/null @@ -1,192 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlManagedInstanceName": "testsqlManagedInstance", - "api-version": "2023-03-15-preview", - "sqlManagedInstance": { - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "sku": { - "name": "vCore", - "tier": "GeneralPurpose", - "dev": true - }, - "properties": { - "admin": "Admin user", - "startTime": "Instance start time", - "endTime": "Instance end time", - "basicLoginInformation": { - "username": "username", - "password": "********" - }, - "activeDirectoryInformation": { - "keytabInformation": { - "keytab": "********" - } - }, - "licenseType": "LicenseIncluded", - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "k8sRaw": { - "additionalProperty": 1234, - "spec": { - "replicas": 1, - "scheduling": { - "default": { - "resources": { - "requests": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - }, - "limits": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - } - } - } - } - } - } - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "admin": "Admin user", - "startTime": "Instance start time", - "endTime": "Instance end time", - "basicLoginInformation": { - "username": "username" - }, - "activeDirectoryInformation": { - "keytabInformation": {} - }, - "licenseType": "LicenseIncluded", - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "k8sRaw": { - "additionalProperty": 1234, - "spec": { - "replicas": 1, - "scheduling": { - "default": { - "resources": { - "requests": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - }, - "limits": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - } - } - } - } - } - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "vCore", - "tier": "GeneralPurpose", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", - "name": "testsqlManagedInstance", - "type": "Microsoft.AzureArcData/sqlManagedInstances" - } - }, - "201": { - "body": { - "properties": { - "admin": "Admin user", - "startTime": "Instance start time", - "endTime": "Instance end time", - "basicLoginInformation": { - "username": "username" - }, - "activeDirectoryInformation": { - "keytabInformation": {} - }, - "licenseType": "LicenseIncluded", - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "k8sRaw": { - "additionalProperty": 1234, - "spec": { - "replicas": 1, - "scheduling": { - "default": { - "resources": { - "requests": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - }, - "limits": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - } - } - } - } - } - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "vCore", - "tier": "GeneralPurpose", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", - "name": "testsqlManagedInstance", - "type": "Microsoft.AzureArcData/sqlManagedInstances" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlServerInstance.json deleted file mode 100644 index 65cdf69ae511..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/CreateOrUpdateSqlServerInstance.json +++ /dev/null @@ -1,112 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testsqlServerInstance", - "api-version": "2023-03-15-preview", - "sqlServerInstance": { - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "properties": { - "version": "SQL Server 2012", - "edition": "Developer", - "containerResourceId": "Resource id of hosting Arc Machine", - "vCore": "4", - "cores": "4", - "patchLevel": "patchlevel", - "collation": "collation", - "currentVersion": "2012", - "instanceName": "name of instance", - "tcpDynamicPorts": "1433", - "tcpStaticPorts": "1433", - "productId": "sql id", - "licenseType": "Free", - "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", - "status": "Registered", - "azureDefenderStatus": "Protected", - "hostType": "Physical Server" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "version": "SQL Server 2012", - "edition": "Developer", - "containerResourceId": "Resource id of hosting Arc Machine", - "createTime": "01/01/2020 01:01:01", - "patchLevel": "patchlevel", - "collation": "collation", - "currentVersion": "2012", - "instanceName": "name of instance", - "tcpDynamicPorts": "1433", - "tcpStaticPorts": "1433", - "productId": "sql id", - "vCore": "4", - "cores": "4", - "licenseType": "Free", - "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", - "status": "Registered", - "azureDefenderStatus": "Protected", - "hostType": "Physical Server" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", - "name": "testsqlServerInstance", - "type": "Microsoft.AzureArcData/SqlServerInstances" - } - }, - "201": { - "body": { - "properties": { - "version": "SQL Server 2017", - "edition": "Developer", - "containerResourceId": "Arc Machine Name", - "createTime": "01/01/2020 01:01:01", - "patchLevel": "patchlevel", - "collation": "collation", - "currentVersion": "2008 R2", - "instanceName": "name of instance", - "tcpDynamicPorts": "1433", - "tcpStaticPorts": "1433", - "productId": "sql id", - "vCore": "4", - "cores": "4", - "licenseType": "Free", - "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", - "status": "Connected", - "azureDefenderStatus": "Protected" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", - "name": "testsqlServerInstance", - "type": "Microsoft.AzureArcData/SqlServerInstances" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteActiveDirectoryConnector.json deleted file mode 100644 index a06d18233f6f..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteActiveDirectoryConnector.json +++ /dev/null @@ -1,26 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "dataControllerName": "testdataController", - "activeDirectoryConnectorName": "testADConnector", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "202": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlAvailabilityGroupDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlAvailabilityGroupDatabase.json deleted file mode 100644 index 3e423595e65e..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlAvailabilityGroupDatabase.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlAvailabilityGroupDatabaseName": "testSqlDatabase", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlAvailabilityGroupReplica.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlAvailabilityGroupReplica.json deleted file mode 100644 index 78292239380b..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlAvailabilityGroupReplica.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testsqlManagedInstance", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlServerAvailabilityGroup.json deleted file mode 100644 index 56dd5c233bb3..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlServerAvailabilityGroup.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testsqlInstanceAvailabilityGroup", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlServerDatabase.json deleted file mode 100644 index ba071ae8013f..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteArcSqlServerDatabase.json +++ /dev/null @@ -1,21 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testsqlManagedInstance", - "databaseName": "testdb", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteDataController.json deleted file mode 100644 index 2746282c604c..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteDataController.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "dataControllerName": "testdataController", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "202": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteFailoverGroup.json deleted file mode 100644 index ad9be7f054d4..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteFailoverGroup.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlManagedInstanceName": "testSqlManagedInstance", - "failoverGroupName": "testFailoverGroupName", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": {}, - "202": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": {} - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeletePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeletePostgresInstance.json deleted file mode 100644 index cc2d79589fa0..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeletePostgresInstance.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "postgresInstanceName": "testpostgresInstance", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "202": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlAvailabilityGroup.json deleted file mode 100644 index e964f1d015f6..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlAvailabilityGroup.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlAvailabilityGroupName": "testsqlAvailabilityGroup", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "202": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlManagedInstance.json deleted file mode 100644 index be47a20c0305..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlManagedInstance.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlManagedInstanceName": "testsqlManagedInstance", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "202": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlServerInstance.json deleted file mode 100644 index 7d73ab201ed2..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/DeleteSqlServerInstance.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testsqlServerInstance", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "202": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - }, - "204": { - "headers": { - "azure-AsyncOperation": "http://azure.async.operation/status" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetActiveDirectoryConnector.json deleted file mode 100644 index 37b7236c47d4..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetActiveDirectoryConnector.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "dataControllerName": "testdataController", - "activeDirectoryConnectorName": "testADConnector", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "properties": { - "spec": { - "activeDirectory": { - "realm": "CONTOSO.LOCAL", - "serviceAccountProvisioning": "manual", - "domainControllers": { - "primaryDomainController": { - "hostname": "dc1.contoso.local" - }, - "secondaryDomainControllers": [ - { - "hostname": "dc2.contoso.local" - }, - { - "hostname": "dc3.contoso.local" - } - ] - }, - "netbiosDomainName": "CONTOSO" - }, - "dns": { - "nameserverIPAddresses": [ - "11.11.111.111", - "22.22.222.222" - ], - "replicas": 1, - "preferK8sDnsForPtrLookups": false, - "domainName": "contoso.local" - } - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector", - "name": "testADConnector", - "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlAvailabilityGroupDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlAvailabilityGroupDatabase.json deleted file mode 100644 index 90b40f5e2a73..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlAvailabilityGroupDatabase.json +++ /dev/null @@ -1,47 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlAvailabilityGroupDatabaseName": "testSqlDatabase", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsAG/databases/testSqlDatabase", - "name": "testSqlDatabase", - "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/databases", - "properties": { - "groupDatabaseId": "00000000-1111-2222-3333-444444444444", - "value": [ - { - "replicaName": "sqlServer1", - "isLocal": true, - "isPrimaryReplica": true, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - }, - { - "replicaName": "sqlServer2", - "isLocal": false, - "isPrimaryReplica": false, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - } - ] - }, - "tags": { - "mytag": "myval" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlAvailabilityGroupReplica.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlAvailabilityGroupReplica.json deleted file mode 100644 index e30cc06b9ed0..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlAvailabilityGroupReplica.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testSqlServerInstance", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsAG/sqlServerInstances/testSqlServerInstance", - "name": "testSqlServerInstance", - "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/sqlServerInstances", - "properties": { - "replicaId": "00000000-1111-2222-3333-444444444444", - "replicaName": "testSqlServerInstance", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlServerAvailabilityGroup.json deleted file mode 100644 index 37a6932e2961..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlServerAvailabilityGroup.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testSqlServerInstance", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testSqlServerInstance/sqlAvailabilityGroups/testAG", - "name": "testAG", - "type": "Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups", - "properties": { - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "availabilityGroupName": "testAG", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlServerDatabase.json deleted file mode 100644 index cdbd6992da96..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetArcSqlServerDatabase.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testSqlServerInstance", - "databaseName": "testdb", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", - "name": "testdb", - "type": "Microsoft.AzureArcData/sqlServerInstances/databases", - "properties": { - "collationName": "SQL_Latin1_General_CP1_CI_AS", - "databaseCreationDate": "2022-04-05T16:26:33.883Z", - "compatibilityLevel": 150, - "state": "Online", - "isReadOnly": true, - "recoveryMode": "Full", - "sizeMB": 150.00, - "spaceAvailableMB": 100.00, - "databaseOptions": { - "isAutoCloseOn": true, - "isAutoShrinkOn": true, - "isAutoCreateStatsOn": true, - "isAutoUpdateStatsOn": true, - "isMemoryOptimizationEnabled": true, - "isRemoteDataArchiveEnabled": true, - "isEncrypted": true, - "isTrustworthyOn": true - }, - "backupInformation": { - "lastFullBackup": "2022-05-05T16:26:33.883Z", - "lastLogBackup": "2022-05-10T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetDataController.json deleted file mode 100644 index dfb44f09ea1c..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetDataController.json +++ /dev/null @@ -1,65 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "dataControllerName": "testdataController", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "properties": { - "onPremiseProperty": { - "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", - "publicSigningKey": "publicOnPremSigningKey", - "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" - }, - "basicLoginInformation": { - "username": "username" - }, - "metricsDashboardCredential": { - "username": "username" - }, - "logsDashboardCredential": { - "username": "username" - }, - "logAnalyticsWorkspaceConfig": { - "workspaceId": "00000000-1111-2222-3333-444444444444" - }, - "uploadServicePrincipal": { - "clientId": "00000000-1111-2222-3333-444444444444", - "tenantId": "00000000-1111-2222-3333-444444444444", - "authority": "https://login.microsoftonline.com/" - }, - "uploadWatermark": { - "metrics": "2020-01-01T17:18:19.1234567Z", - "logs": "2020-01-01T17:18:19.1234567Z", - "usages": "2020-01-01T17:18:19.1234567Z" - }, - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "infrastructure": "onpremises" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController", - "name": "testdataController", - "type": "Microsoft.AzureArcData/dataControllers" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetFailoverGroup.json deleted file mode 100644 index 6f8f7ad7bce9..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetFailoverGroup.json +++ /dev/null @@ -1,38 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlManagedInstanceName": "testSqlManagedInstance", - "failoverGroupName": "testFailoverGroupName", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "properties": { - "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", - "spec": { - "sharedName": "testSharedName", - "sourceMI": "sourceSQLMI", - "partnerMI": "partnerMI", - "partnerMirroringURL": "11.11.111.111", - "partnerMirroringCert": "testCert", - "partnerSyncMode": "async", - "role": "primary" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", - "name": "testFailoverGroupName", - "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetPostgresInstance.json deleted file mode 100644 index a7714b7a53e2..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetPostgresInstance.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "postgresInstanceName": "testpostgresInstances", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "properties": { - "basicLoginInformation": { - "username": "username" - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "default", - "tier": "Hyperscale", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances", - "name": "testpostgresInstances", - "type": "Microsoft.AzureArcData/PostgresInstances" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlAvailabilityGroup.json deleted file mode 100644 index 4adc6b379340..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlAvailabilityGroup.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlAvailabilityGroupName": "testsqlAvailabilityGroup", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "properties": { - "availabilityGroupName": "myAvailabilityGroup", - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "instanceName": "testInstance", - "collectionTimestamp": "2022-05-05T16:26:33.883Z", - "version": 0, - "basicFeatures": false, - "dtcSupport": false, - "dbFailover": true, - "isDistributed": false, - "clusterTypeDesc": "WSFC", - "requiredSynchronizedSecondariesCommit": 0, - "isContained": false - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlAvailabilityGroups/testsqlAvailabilityGroup", - "name": "testsqlServerInstance", - "type": "Microsoft.AzureArcData/SqlAvailabilityGroups" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlManagedInstance.json deleted file mode 100644 index 0826c7c4f7a4..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlManagedInstance.json +++ /dev/null @@ -1,74 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlManagedInstanceName": "testsqlManagedInstance", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "properties": { - "admin": "Admin user", - "startTime": "Instance start time", - "endTime": "Instance end time", - "basicLoginInformation": { - "username": "username" - }, - "activeDirectoryInformation": { - "keytabInformation": {} - }, - "licenseType": "LicenseIncluded", - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "k8sRaw": { - "additionalProperty": 1234, - "spec": { - "replicas": 1, - "scheduling": { - "default": { - "resources": { - "requests": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - }, - "limits": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - } - } - } - } - } - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "vCore", - "tier": "GeneralPurpose", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", - "name": "testsqlManagedInstance", - "type": "Microsoft.AzureArcData/sqlManagedInstance" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlServerInstance.json deleted file mode 100644 index 0542bcbfa134..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/GetSqlServerInstance.json +++ /dev/null @@ -1,49 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testsqlServerInstance", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "properties": { - "version": "SQL Server 2012", - "edition": "Developer", - "containerResourceId": "Resource id of hosting Arc Machine", - "createTime": "01/01/2020 01:01:01", - "patchLevel": "patchlevel", - "collation": "collation", - "currentVersion": "2012", - "instanceName": "name of instance", - "tcpDynamicPorts": "1433", - "tcpStaticPorts": "1433", - "productId": "sql id", - "vCore": "4", - "cores": "4", - "licenseType": "Free", - "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", - "azureDefenderStatus": "Protected", - "status": "Registered", - "hostType": "Physical Server" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", - "name": "testsqlServerInstance", - "type": "Microsoft.AzureArcData/SqlServerInstances" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByDataControllerActiveDirectoryConnector.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByDataControllerActiveDirectoryConnector.json deleted file mode 100644 index b1384036b2cd..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByDataControllerActiveDirectoryConnector.json +++ /dev/null @@ -1,104 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "api-version": "2023-03-15-preview", - "dataControllerName": "testdataController" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "spec": { - "activeDirectory": { - "realm": "CONTOSO.LOCAL", - "serviceAccountProvisioning": "manual", - "domainControllers": { - "primaryDomainController": { - "hostname": "dc1.contoso.local" - }, - "secondaryDomainControllers": [ - { - "hostname": "dc2.contoso.local" - }, - { - "hostname": "dc3.contoso.local" - } - ] - }, - "netbiosDomainName": "CONTOSO" - }, - "dns": { - "nameserverIPAddresses": [ - "11.11.111.111", - "22.22.222.222" - ], - "replicas": 1, - "preferK8sDnsForPtrLookups": false, - "domainName": "contoso.local" - } - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector1", - "name": "testADConnector1", - "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" - }, - { - "properties": { - "spec": { - "activeDirectory": { - "realm": "CONTOSO.LOCAL", - "serviceAccountProvisioning": "manual", - "domainControllers": { - "primaryDomainController": { - "hostname": "dc4.contoso.local" - }, - "secondaryDomainControllers": [ - { - "hostname": "dc5.contoso.local" - }, - { - "hostname": "dc6.contoso.local" - } - ] - }, - "netbiosDomainName": "CONTOSO" - }, - "dns": { - "nameserverIPAddresses": [ - "11.11.111.111", - "22.22.222.222" - ], - "replicas": 1, - "preferK8sDnsForPtrLookups": false, - "domainName": "contoso.local" - } - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController/activeDirectoryConnectors/testADConnector2", - "name": "testADConnector2", - "type": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupDataController.json deleted file mode 100644 index dd2dead1d65a..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupDataController.json +++ /dev/null @@ -1,115 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "onPremiseProperty": { - "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", - "publicSigningKey": "publicOnPremSigningKey", - "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" - }, - "basicLoginInformation": { - "username": "username" - }, - "metricsDashboardCredential": { - "username": "username" - }, - "logsDashboardCredential": { - "username": "username" - }, - "logAnalyticsWorkspaceConfig": { - "workspaceId": "00000000-1111-2222-3333-444444444444" - }, - "uploadServicePrincipal": { - "clientId": "00000000-1111-2222-3333-444444444444", - "tenantId": "00000000-1111-2222-3333-444444444444", - "authority": "https://login.microsoftonline.com/" - }, - "uploadWatermark": { - "metrics": "2020-01-01T17:18:19.1234567Z", - "logs": "2020-01-01T17:18:19.1234567Z", - "usages": "2020-01-01T17:18:19.1234567Z" - }, - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "infrastructure": "onpremises" - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", - "name": "testdataController1", - "type": "Microsoft.AzureArcData/dataControllers" - }, - { - "properties": { - "onPremiseProperty": { - "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", - "publicSigningKey": "publicOnPremSigningKey", - "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" - }, - "basicLoginInformation": { - "username": "username" - }, - "logAnalyticsWorkspaceConfig": { - "workspaceId": "00000000-1111-2222-3333-444444444444" - }, - "uploadServicePrincipal": { - "clientId": "00000000-1111-2222-3333-444444444444", - "tenantId": "00000000-1111-2222-3333-444444444444", - "authority": "https://login.microsoftonline.com/" - }, - "uploadWatermark": { - "metrics": "2020-01-01T17:18:19.1234567Z", - "logs": "2020-01-01T17:18:19.1234567Z", - "usages": "2020-01-01T17:18:19.1234567Z" - }, - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "infrastructure": "onpremises" - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", - "name": "testdataController2", - "type": "Microsoft.AzureArcData/dataControllers" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupPostgresInstance.json deleted file mode 100644 index a82ff58986ae..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupPostgresInstance.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "basicLoginInformation": { - "username": "username" - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "default", - "tier": "Hyperscale", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances1", - "name": "testpostgresInstances1", - "type": "Microsoft.AzureArcData/PostgresInstances" - }, - { - "properties": { - "basicLoginInformation": { - "username": "username" - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "default", - "tier": "Hyperscale", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances2", - "name": "testpostgresInstances2", - "type": "Microsoft.AzureArcData/PostgresInstances" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlAvailabilityGroup.json deleted file mode 100644 index b5235566ff61..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlAvailabilityGroup.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "availabilityGroupName": "myAvailabilityGroup1", - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "instanceName": "testInstance", - "collectionTimestamp": "2022-05-05T16:26:33.883Z", - "version": 0, - "basicFeatures": false, - "dtcSupport": false, - "dbFailover": true, - "isDistributed": false, - "clusterTypeDesc": "WSFC", - "requiredSynchronizedSecondariesCommit": 0, - "isContained": false - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlAvailabilityGroups/sqlAvailabilityGroup1", - "name": "sqlAvailabilityGroup1", - "type": "Microsoft.AzureArcData/SqlAvailabilityGroups" - }, - { - "properties": { - "availabilityGroupName": "myAvailabilityGroup2", - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "instanceName": "testInstance", - "collectionTimestamp": "2022-05-05T16:26:33.883Z", - "version": 0, - "basicFeatures": false, - "dtcSupport": false, - "dbFailover": true, - "isDistributed": false, - "clusterTypeDesc": "WSFC", - "requiredSynchronizedSecondariesCommit": 0, - "isContained": false - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlAvailabilityGroups/sqlAvailabilityGroup2", - "name": "sqlAvailabilityGroup2", - "type": "Microsoft.AzureArcData/SqlAvailabilityGroups" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlManagedInstance.json deleted file mode 100644 index 267b1279b932..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlManagedInstance.json +++ /dev/null @@ -1,137 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "admin": "Admin user", - "startTime": "Instance start time", - "endTime": "Instance end time", - "basicLoginInformation": { - "username": "username" - }, - "activeDirectoryInformation": { - "keytabInformation": {} - }, - "licenseType": "LicenseIncluded", - "k8sRaw": { - "additionalProperty": 1234, - "spec": { - "replicas": 1, - "scheduling": { - "default": { - "resources": { - "requests": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - }, - "limits": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - } - } - } - } - } - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "vCore", - "tier": "GeneralPurpose", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance1", - "name": "sqlManagedInstances1", - "type": "Microsoft.AzureArcData/sqlManagedInstances" - }, - { - "properties": { - "admin": "Admin user", - "startTime": "Instance start time", - "endTime": "Instance end time", - "basicLoginInformation": { - "username": "username" - }, - "activeDirectoryInformation": { - "keytabInformation": {} - }, - "licenseType": "LicenseIncluded", - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "k8sRaw": { - "additionalProperty": 1234, - "spec": { - "replicas": 1, - "scheduling": { - "default": { - "resources": { - "requests": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - }, - "limits": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - } - } - } - } - } - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "vCore", - "tier": "GeneralPurpose", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/sqlManagedInstance2", - "name": "sqlManagedInstances2", - "type": "Microsoft.AzureArcData/sqlManagedInstances" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlServerInstance.json deleted file mode 100644 index 580c106df415..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListByResourceGroupSqlServerInstance.json +++ /dev/null @@ -1,88 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "version": "SQL Server 2012", - "edition": "Developer", - "containerResourceId": "Resource id of hosting Arc Machine", - "createTime": "01/01/2020 01:01:01", - "patchLevel": "patchlevel", - "collation": "collation", - "currentVersion": "2012", - "instanceName": "name of instance", - "tcpDynamicPorts": "1433", - "tcpStaticPorts": "1433", - "productId": "sql id", - "vCore": "4", - "cores": "4", - "licenseType": "Free", - "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", - "azureDefenderStatus": "Protected", - "status": "Registered", - "hostType": "Physical Server" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", - "name": "sqlServerInstance1", - "type": "Microsoft.AzureArcData/SqlServerInstances" - }, - { - "properties": { - "version": "SQL Server 2017", - "edition": "Developer", - "containerResourceId": "Arc Machine Name", - "createTime": "01/01/2020 01:01:01", - "patchLevel": "patchlevel", - "collation": "collation", - "currentVersion": "2008 R2", - "instanceName": "name of instance", - "tcpDynamicPorts": "1433", - "tcpStaticPorts": "1433", - "productId": "sql id", - "vCore": "4", - "cores": "4", - "licenseType": "Free", - "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", - "azureDefenderStatus": "Protected", - "status": "Connected" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", - "name": "sqlServerInstance2", - "type": "Microsoft.AzureArcData/SqlServerInstances" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlAvailabilityGroupDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlAvailabilityGroupDatabase.json deleted file mode 100644 index 0de1f3665acc..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlAvailabilityGroupDatabase.json +++ /dev/null @@ -1,100 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsAG/databases/testSqlDatabase1", - "name": "testSqlDatabase1", - "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/databases", - "properties": { - "groupDatabaseId": "00000000-1111-2222-3333-444444444444", - "value": [ - { - "replicaName": "sqlServer1", - "isLocal": true, - "isPrimaryReplica": true, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - }, - { - "replicaName": "sqlServer2", - "isLocal": false, - "isPrimaryReplica": false, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - } - ] - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - }, - { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsAG/databases/testSqlDatabase2", - "name": "testSqlDatabase2", - "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/databases", - "properties": { - "groupDatabaseId": "00000000-1111-2222-3333-444444444444", - "value": [ - { - "replicaName": "sqlServer1", - "isLocal": true, - "isPrimaryReplica": true, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - }, - { - "replicaName": "sqlServer2", - "isLocal": false, - "isPrimaryReplica": false, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - } - ] - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlAvailabilityGroupReplica.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlAvailabilityGroupReplica.json deleted file mode 100644 index f6f639c9a10a..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlAvailabilityGroupReplica.json +++ /dev/null @@ -1,104 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlAvailabilityGroupName": "testAG", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsAG/sqlServerInstances/testSqlServerInstance", - "name": "testSqlServerInstance", - "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/sqlServerInstances", - "properties": { - "replicaId": "00000000-1111-2222-3333-444444444444", - "replicaName": "testSqlServerInstance", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - }, - { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsAG/sqlServerInstances/testSqlServerInstance1", - "name": "testSqlServerInstance1", - "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/sqlServerInstances", - "properties": { - "replicaId": "00000000-1111-2222-5555-444444444444", - "replicaName": "testSqlServerInstance1", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlManagedInstanceFailoverGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlManagedInstanceFailoverGroup.json deleted file mode 100644 index f88596772d08..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlManagedInstanceFailoverGroup.json +++ /dev/null @@ -1,66 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "api-version": "2023-03-15-preview", - "sqlManagedInstanceName": "testSqlManagedInstance" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", - "spec": { - "sharedName": "testSharedName", - "sourceMI": "sourceSQLMI", - "partnerMI": "partnerMI", - "partnerMirroringURL": "11.11.111.111", - "partnerMirroringCert": "testCert", - "partnerSyncMode": "async", - "role": "primary" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", - "name": "testFailoverGroupName", - "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" - }, - { - "properties": { - "partnerManagedInstanceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/partnerMI", - "spec": { - "sharedName": "testSharedName", - "sourceMI": "sourceSQLMI", - "partnerMI": "partnerMI", - "partnerMirroringURL": "11.11.111.111", - "partnerMirroringCert": "testCert", - "partnerSyncMode": "async", - "role": "primary" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testSqlManagedInstance/failoverGroups/testFailoverGroupName", - "name": "testFailoverGroupName", - "type": "Microsoft.AzureArcData/sqlManagedInstances/failoverGroups" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json deleted file mode 100644 index 1e3092646f63..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlServerInstanceAvailabilityGroup.json +++ /dev/null @@ -1,104 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testSqlServerInstance", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServerInstance/sqlAvailabilityGroups/testAG", - "name": "testAG", - "type": "Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups", - "properties": { - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "availabilityGroupName": "testAG", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - }, - { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlServerInstances/testSqlServerInstance/sqlAvailabilityGroups/testAG1", - "name": "testAG1", - "type": "Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups", - "properties": { - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "availabilityGroupName": "testAG1", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlServerInstanceDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlServerInstanceDatabase.json deleted file mode 100644 index c949aaa15e95..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListBySqlServerInstanceDatabase.json +++ /dev/null @@ -1,98 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testSqlServerInstance", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", - "name": "testdb", - "type": "Microsoft.AzureArcData/sqlServerInstances/databases", - "properties": { - "collationName": "SQL_Latin1_General_CP1_CI_AS", - "databaseCreationDate": "2022-04-05T16:26:33.883Z", - "compatibilityLevel": 150, - "state": "Online", - "isReadOnly": true, - "recoveryMode": "Full", - "sizeMB": 150.00, - "spaceAvailableMB": 100.00, - "databaseOptions": { - "isAutoCloseOn": true, - "isAutoShrinkOn": true, - "isAutoCreateStatsOn": true, - "isAutoUpdateStatsOn": true, - "isMemoryOptimizationEnabled": true, - "isRemoteDataArchiveEnabled": true, - "isEncrypted": true, - "isTrustworthyOn": true - }, - "backupInformation": { - "lastFullBackup": "2022-05-05T16:26:33.883Z", - "lastLogBackup": "2022-05-10T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - }, - { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb1", - "name": "testdb1", - "type": "Microsoft.AzureArcData/sqlServerInstances/databases", - "properties": { - "collationName": "SQL_Latin1_General_CP1_CI_AS", - "databaseCreationDate": "2022-04-05T16:26:33.883Z", - "compatibilityLevel": 150, - "state": "Online", - "isReadOnly": true, - "recoveryMode": "Full", - "sizeMB": 150.00, - "spaceAvailableMB": 100.00, - "databaseOptions": { - "isAutoCloseOn": true, - "isAutoShrinkOn": true, - "isAutoCreateStatsOn": true, - "isAutoUpdateStatsOn": true, - "isMemoryOptimizationEnabled": true, - "isRemoteDataArchiveEnabled": true, - "isEncrypted": true, - "isTrustworthyOn": true - }, - "backupInformation": { - "lastFullBackup": "2022-05-05T16:26:33.883Z", - "lastLogBackup": "2022-05-10T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - } - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListOperation.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListOperation.json deleted file mode 100644 index 7a45a13987c2..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListOperation.json +++ /dev/null @@ -1,353 +0,0 @@ -{ - "parameters": { - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.AzureArcData/Locations/OperationStatuses/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "Locations/OperationStatuses", - "operation": "read_OperationStatuses", - "description": "read OperationStatuses" - } - }, - { - "name": "Microsoft.AzureArcData/Locations/OperationStatuses/write", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "Locations/OperationStatuses", - "operation": "write_OperationStatuses", - "description": "write OperationStatuses" - } - }, - { - "name": "Microsoft.AzureArcData/dataControllers/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "dataControllers", - "operation": "DataControllers_ListInSubscription", - "description": "read dataControllers" - } - }, - { - "name": "Microsoft.AzureArcData/dataControllers/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "dataControllers", - "operation": "DataControllers_ListInGroup", - "description": "read dataControllers" - } - }, - { - "name": "Microsoft.AzureArcData/dataControllers/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "dataControllers", - "operation": "DataControllers_GetDataController", - "description": "Retrieves a dataController resource" - } - }, - { - "name": "Microsoft.AzureArcData/dataControllers/write", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "dataControllers", - "operation": "DataControllers_PutDataController", - "description": "Creates or replaces a dataController resource" - } - }, - { - "name": "Microsoft.AzureArcData/dataControllers/delete", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "dataControllers", - "operation": "DataControllers_DeleteDataController", - "description": "Deletes a dataController resource" - } - }, - { - "name": "Microsoft.AzureArcData/dataControllers/write", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "dataControllers", - "operation": "DataControllers_PatchDataController", - "description": "Updates a dataController resource" - } - }, - { - "name": "Microsoft.AzureArcData/sqlManagedInstances/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlManagedInstances", - "operation": "SqlManagedInstances_List", - "description": "read sqlManagedInstances" - } - }, - { - "name": "Microsoft.AzureArcData/sqlManagedInstances/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlManagedInstances", - "operation": "SqlManagedInstances_ListByResourceGroup", - "description": "Gets all sqlManagedInstances in a resource group." - } - }, - { - "name": "Microsoft.AzureArcData/sqlManagedInstances/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlManagedInstances", - "operation": "SqlManagedInstances_Get", - "description": "Retrieves a SQL Managed Instance resource" - } - }, - { - "name": "Microsoft.AzureArcData/sqlManagedInstances/write", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlManagedInstances", - "operation": "SqlManagedInstances_Create", - "description": "Creates or replaces a SQL Managed Instance resource" - } - }, - { - "name": "Microsoft.AzureArcData/sqlManagedInstances/delete", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlManagedInstances", - "operation": "SqlManagedInstances_Delete", - "description": "Deletes a SQL Managed Instance resource" - } - }, - { - "name": "Microsoft.AzureArcData/sqlManagedInstances/write", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlManagedInstances", - "operation": "SqlManagedInstances_Update", - "description": "Updates a SQL Managed Instance resource" - } - }, - { - "name": "Microsoft.AzureArcData/sqlServerInstances/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlServerInstances", - "operation": "SqlServerInstances_List", - "description": "read sqlServerInstances" - } - }, - { - "name": "Microsoft.AzureArcData/sqlServerInstances/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlServerInstances", - "operation": "SqlServerInstances_ListByResourceGroup", - "description": "Gets all sqlServerInstances in a resource group." - } - }, - { - "name": "Microsoft.AzureArcData/sqlServerInstances/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlServerInstances", - "operation": "SqlServerInstances_Get", - "description": "Retrieves a SQL Server Instance resource" - } - }, - { - "name": "Microsoft.AzureArcData/sqlServerInstances/write", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlServerInstances", - "operation": "SqlServerInstances_Create", - "description": "Creates or replaces a SQL Server Instance resource" - } - }, - { - "name": "Microsoft.AzureArcData/sqlServerInstances/delete", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlServerInstances", - "operation": "SqlServerInstances_Delete", - "description": "Deletes a SQL Server Instance resource" - } - }, - { - "name": "Microsoft.AzureArcData/sqlServerInstances/databases/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlServerInstances/databases", - "operation": "SqlServerDatabases_List", - "description": "List all database resources in a Sql Server Instance." - } - }, - { - "name": "Microsoft.AzureArcData/sqlServerInstances/databases/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlServerInstances/databases", - "operation": "SqlServerDatabases_Get", - "description": "Retrieves a database resource" - } - }, - { - "name": "Microsoft.AzureArcData/sqlServerInstances/databases/write", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlServerInstances/databases", - "operation": "SqlServerDatabases_Create", - "description": "Creates or updates a database resource." - } - }, - { - "name": "Microsoft.AzureArcData/sqlServerInstances/databases/delete", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlServerInstances/databases", - "operation": "SqlServerDatabases_Delete", - "description": "Deletes a database resource." - } - }, - { - "name": "Microsoft.AzureArcData/sqlServerInstances/write", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "sqlServerInstances", - "operation": "SqlServerInstances_Update", - "description": "Updates a SQL Server Instance resource" - } - }, - { - "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "dataControllers/activeDirectoryConnectors", - "operation": "ActiveDirectoryConnectors_List", - "description": "read activeDirectoryConnectors" - } - }, - { - "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "dataControllers/activeDirectoryConnectors", - "operation": "ActiveDirectoryConnectors_Get", - "description": "Retrieves an active directory connector resource" - } - }, - { - "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/write", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "dataControllers/activeDirectoryConnectors", - "operation": "ActiveDirectoryConnectors_Create", - "description": "Creates or replaces an active directory connector resource." - } - }, - { - "name": "Microsoft.AzureArcData/dataControllers/activeDirectoryConnectors/delete", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "dataControllers/activeDirectoryConnectors", - "operation": "ActiveDirectoryConnectors_Delete", - "description": "Deletes an active directory connector resource" - } - }, - { - "name": "Microsoft.AzureArcData/postgresInstances/read", - "isDataAction": false, - "display": { - "resource": "Microsoft.AzureArcData", - "provider": "Azure Arc Data Resource Provider.", - "operation": "Get Postgres Instance details.", - "description": "Retrieves details of Postgres Instances." - } - }, - { - "name": "Microsoft.AzureArcData/postgresInstances/write", - "isDataAction": false, - "display": { - "resource": "Microsoft.AzureArcData", - "provider": "Azure Arc Data Resource Provider.", - "operation": "Create new or update existing Postgres Instances.", - "description": "Create a new or change properties of existing Postgres Instances." - } - }, - { - "name": "Microsoft.AzureArcData/postgresInstances/delete", - "isDataAction": false, - "display": { - "resource": "Microsoft.AzureArcData", - "provider": "Azure Arc Data Resource Provider.", - "operation": "Delete exisiting Postgres Instances.", - "description": "Delete exisiting Postgres Instances." - } - }, - { - "name": "Microsoft.AzureArcData/register/action", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "Microsoft.AzureArcData", - "operation": "Register the Microsoft.AzureArcData", - "description": "Register the subscription for Microsoft.AzureArcData" - } - }, - { - "name": "Microsoft.AzureArcData/unregister/action", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "Microsoft.AzureArcData", - "operation": "Unregister the Microsoft.AzureArcData", - "description": "Unregister the subscription for Microsoft.AzureArcData" - } - }, - { - "name": "Microsoft.AzureArcData/Operations/read", - "isDataAction": false, - "display": { - "provider": "Microsoft.AzureArcData", - "resource": "Operations", - "operation": "read_Operations", - "description": "read Operations" - } - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionDataController.json deleted file mode 100644 index d5219ce305a5..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionDataController.json +++ /dev/null @@ -1,119 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "onPremiseProperty": { - "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", - "publicSigningKey": "publicOnPremSigningKey", - "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" - }, - "basicLoginInformation": { - "username": "username" - }, - "metricsDashboardCredential": { - "username": "username" - }, - "logsDashboardCredential": { - "username": "username" - }, - "logAnalyticsWorkspaceConfig": { - "workspaceId": "00000000-1111-2222-3333-444444444444" - }, - "uploadServicePrincipal": { - "clientId": "00000000-1111-2222-3333-444444444444", - "tenantId": "00000000-1111-2222-3333-444444444444", - "authority": "https://login.microsoftonline.com/" - }, - "uploadWatermark": { - "metrics": "2020-01-01T17:18:19.1234567Z", - "logs": "2020-01-01T17:18:19.1234567Z", - "usages": "2020-01-01T17:18:19.1234567Z" - }, - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "infrastructure": "onpremises" - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", - "name": "testdataController1", - "type": "Microsoft.AzureArcData/dataControllers" - }, - { - "properties": { - "onPremiseProperty": { - "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", - "publicSigningKey": "publicOnPremSigningKey", - "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" - }, - "basicLoginInformation": { - "username": "username" - }, - "metricsDashboardCredential": { - "username": "username" - }, - "logsDashboardCredential": { - "username": "username" - }, - "logAnalyticsWorkspaceConfig": { - "workspaceId": "00000000-1111-2222-3333-444444444444" - }, - "uploadServicePrincipal": { - "clientId": "00000000-1111-2222-3333-444444444444", - "tenantId": "00000000-1111-2222-3333-444444444444", - "authority": "https://login.microsoftonline.com/" - }, - "uploadWatermark": { - "metrics": "2020-01-01T17:18:19.1234567Z", - "logs": "2020-01-01T17:18:19.1234567Z", - "usages": "2020-01-01T17:18:19.1234567Z" - }, - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension" - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController2", - "name": "testdataController2", - "type": "Microsoft.AzureArcData/dataControllers" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionPostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionPostgresInstance.json deleted file mode 100644 index 20ef0dbffcbf..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionPostgresInstance.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "basicLoginInformation": { - "username": "username" - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "default", - "tier": "Hyperscale", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances1", - "name": "testpostgresInstances1", - "type": "Microsoft.AzureArcData/PostgresInstances" - }, - { - "properties": { - "basicLoginInformation": { - "username": "username" - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "default", - "tier": "Hyperscale", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstances/testpostgresInstances2", - "name": "testpostgresInstances2", - "type": "Microsoft.AzureArcData/PostgresInstances" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlAvailabilityGroup.json deleted file mode 100644 index bc95373b0df4..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlAvailabilityGroup.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "availabilityGroupName": "myAvailabilityGroup1", - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "instanceName": "testInstance", - "collectionTimestamp": "2022-05-05T16:26:33.883Z", - "version": 0, - "basicFeatures": false, - "dtcSupport": false, - "dbFailover": true, - "isDistributed": false, - "clusterTypeDesc": "WSFC", - "requiredSynchronizedSecondariesCommit": 0, - "isContained": false - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlAvailabilityGroups/sqlAvailabilityGroup1", - "name": "sqlAvailabilityGroup1", - "type": "Microsoft.AzureArcData/SqlAvailabilityGroups" - }, - { - "properties": { - "availabilityGroupName": "myAvailabilityGroup2", - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "instanceName": "testInstance", - "collectionTimestamp": "2022-05-05T16:26:33.883Z", - "version": 0, - "basicFeatures": false, - "dtcSupport": false, - "dbFailover": true, - "isDistributed": false, - "clusterTypeDesc": "WSFC", - "requiredSynchronizedSecondariesCommit": 0, - "isContained": false - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg1/providers/Microsoft.AzureArcData/SqlAvailabilityGroups/sqlAvailabilityGroup2", - "name": "sqlAvailabilityGroup2", - "type": "Microsoft.AzureArcData/SqlAvailabilityGroups" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlManagedInstance.json deleted file mode 100644 index b5e3d9909792..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlManagedInstance.json +++ /dev/null @@ -1,138 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "admin": "Admin user", - "startTime": "Instance start time", - "endTime": "Instance end time", - "basicLoginInformation": { - "username": "username" - }, - "activeDirectoryInformation": { - "keytabInformation": {} - }, - "licenseType": "LicenseIncluded", - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "k8sRaw": { - "additionalProperty": 1234, - "spec": { - "replicas": 1, - "scheduling": { - "default": { - "resources": { - "requests": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - }, - "limits": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - } - } - } - } - } - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "vCore", - "tier": "GeneralPurpose", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance1", - "name": "sqlManagedInstances1", - "type": "Microsoft.AzureArcData/sqlManagedInstances" - }, - { - "properties": { - "admin": "Admin user", - "startTime": "Instance start time", - "endTime": "Instance end time", - "basicLoginInformation": { - "username": "username" - }, - "activeDirectoryInformation": { - "keytabInformation": {} - }, - "licenseType": "LicenseIncluded", - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "k8sRaw": { - "additionalProperty": 1234, - "spec": { - "replicas": 1, - "scheduling": { - "default": { - "resources": { - "requests": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - }, - "limits": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - } - } - } - } - } - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "vCore", - "tier": "GeneralPurpose", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlManagedInstances/sqlManagedInstance2", - "name": "sqlManagedInstances2", - "type": "Microsoft.AzureArcData/sqlManagedInstances" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlServerInstance.json deleted file mode 100644 index 3c26efedec0f..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/ListSubscriptionSqlServerInstance.json +++ /dev/null @@ -1,87 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "api-version": "2023-03-15-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": { - "version": "SQL Server 2012", - "edition": "Developer", - "containerResourceId": "Resource id of hosting Arc Machine", - "createTime": "01/01/2020 01:01:01", - "patchLevel": "patchlevel", - "collation": "collation", - "currentVersion": "2008 R2", - "instanceName": "name of instance", - "tcpDynamicPorts": "1433", - "tcpStaticPorts": "1433", - "productId": "sql id", - "vCore": "4", - "cores": "4", - "licenseType": "Free", - "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", - "azureDefenderStatus": "Protected", - "status": "Registered", - "hostType": "Physical Server" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance1", - "name": "sqlServerInstance1", - "type": "Microsoft.AzureArcData/SqlServerInstances" - }, - { - "properties": { - "version": "SQL Server 2017", - "edition": "Developer", - "containerResourceId": "Arc Machine Name", - "createTime": "01/01/2020 01:01:01", - "patchLevel": "patchlevel", - "collation": "collation", - "currentVersion": "2008 R2", - "instanceName": "name of instance", - "tcpDynamicPorts": "1433", - "tcpStaticPorts": "1433", - "productId": "sql id", - "vCore": "4", - "cores": "4", - "licenseType": "Free", - "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", - "azureDefenderStatus": "Protected", - "status": "Connected" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/sqlServerInstance2", - "name": "sqlServerInstance2", - "type": "Microsoft.AzureArcData/SqlServerInstances" - } - ] - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateDataController.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateDataController.json deleted file mode 100644 index 0a853a9c19cd..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateDataController.json +++ /dev/null @@ -1,75 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "dataControllerName": "testdataController1", - "api-version": "2023-03-15-preview", - "dataControllerResource": { - "tags": { - "mytag": "myval" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "onPremiseProperty": { - "id": "12345678-1234-1234-ab12-1a2b3c4d5e6f", - "publicSigningKey": "publicOnPremSigningKey", - "signingCertificateThumbprint": "Unique thumbprint returned to customer to verify the certificate they uploaded" - }, - "basicLoginInformation": { - "username": "username" - }, - "metricsDashboardCredential": { - "username": "username" - }, - "logsDashboardCredential": { - "username": "username" - }, - "logAnalyticsWorkspaceConfig": { - "workspaceId": "00000000-1111-2222-3333-444444444444" - }, - "uploadServicePrincipal": { - "clientId": "00000000-1111-2222-3333-444444444444", - "tenantId": "00000000-1111-2222-3333-444444444444", - "authority": "https://login.microsoftonline.com/" - }, - "uploadWatermark": { - "metrics": "2020-01-01T17:18:19.1234567Z", - "logs": "2020-01-01T17:18:19.1234567Z", - "usages": "2020-01-01T17:18:19.1234567Z" - }, - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "infrastructure": "onpremises" - }, - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/dataControllers/testdataController1", - "name": "testdataController1", - "type": "Microsoft.AzureArcData/dataControllers" - } - }, - "202": { - "headers": { - "Location": "https://management.azure.com/subscriptions/00000000-1111-2222-3333-444444444444/providers/Microsoft.AzureArcData/operationResults/id1" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdatePostgresInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdatePostgresInstance.json deleted file mode 100644 index 919827d84e1a..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdatePostgresInstance.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "postgresInstanceName": "testpostgresInstance", - "api-version": "2023-03-15-preview", - "parameters": { - "tags": { - "mytag": "myval" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "basicLoginInformation": { - "username": "username" - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "sku": { - "name": "default", - "tier": "Hyperscale", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/PostgresInstance/testpostgresInstance", - "name": "testpostgresInstance", - "type": "Microsoft.AzureArcData/PostgresInstance" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroup.json deleted file mode 100644 index 2119a530772f..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroup.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlAvailabilityGroupName": "testsqlAvailabilityGroup", - "api-version": "2023-03-15-preview", - "parameters": { - "tags": { - "mytag": "myval" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "availabilityGroupName": "myAvailabilityGroup", - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "instanceName": "testInstance", - "collectionTimestamp": "2020-01-02T17:18:19.1234567Z", - "version": 0, - "basicFeatures": false, - "dtcSupport": false, - "dbFailover": true, - "isDistributed": false, - "clusterTypeDesc": "WSFC", - "requiredSynchronizedSecondariesCommit": 0, - "isContained": false - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlAvailabilityGroups/testsqlAvailabilityGroup", - "name": "testsqlAvailabilityGroup", - "type": "Microsoft.AzureArcData/SqlAvailabilityGroup" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroupDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroupDatabase.json deleted file mode 100644 index 6bc30381f62a..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroupDatabase.json +++ /dev/null @@ -1,85 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlAvailabilityGroupDatabaseName": "testSqlDatabase", - "api-version": "2023-03-15-preview", - "sqlAvailabilityGroupName": "testsAG", - "sqlAvailabilityGroupDatabaseUpdate": { - "tags": { - "mytag": "myval1" - }, - "properties": { - "groupDatabaseId": "00000000-1111-2222-3333-444444444444", - "value": [ - { - "replicaName": "sqlServer1", - "isLocal": true, - "isPrimaryReplica": true, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - }, - { - "replicaName": "sqlServer2", - "isLocal": false, - "isPrimaryReplica": false, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsAG/databases/testSqlDatabase", - "name": "testSqlDatabase", - "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/databases", - "properties": { - "groupDatabaseId": "00000000-1111-2222-3333-444444444444", - "value": [ - { - "replicaName": "sqlServer1", - "isLocal": true, - "isPrimaryReplica": true, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - }, - { - "replicaName": "sqlServer2", - "isLocal": false, - "isPrimaryReplica": false, - "synchronizationStateDesc": "SYNCHRONIZED", - "isCommitParticipant": true, - "synchronizationHealthDesc": "HEALTHY", - "databaseStateDesc": "ONLINE", - "isSuspended": false - } - ] - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval1" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroupReplica.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroupReplica.json deleted file mode 100644 index 00f42258ff77..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlAvailabilityGroupReplica.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testSqlServerInstance", - "api-version": "2023-03-15-preview", - "sqlAvailabilityGroupName": "testsAG", - "sqlAvailabilityGroupReplicaUpdate": { - "tags": { - "mytag": "myval1" - } - } - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/testsAG/sqlServerInstances/testSqlServerInstance", - "name": "testSqlServerInstance", - "type": "Microsoft.AzureArcData/sqlAvailabilityGroups/sqlServerInstances", - "properties": { - "replicaId": "00000000-1111-2222-3333-444444444444", - "replicaName": "testSqlServerInstance", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval1" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlManagedInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlManagedInstance.json deleted file mode 100644 index ec0fce42e7ce..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlManagedInstance.json +++ /dev/null @@ -1,76 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlManagedInstanceName": "testsqlManagedInstance", - "api-version": "2023-03-15-preview", - "parameters": { - "tags": { - "mytag": "myval" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "admin": "Admin user", - "startTime": "Instance start time", - "endTime": "Instance end time", - "basicLoginInformation": { - "username": "username" - }, - "activeDirectoryInformation": { - "keytabInformation": {} - }, - "licenseType": "LicenseIncluded", - "clusterId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s", - "extensionId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Kubernetes/connectedClusters/connectedk8s/providers/Microsoft.KubernetesConfiguration/extensions/extension", - "k8sRaw": { - "additionalProperty": 1234, - "spec": { - "replicas": 1, - "scheduling": { - "default": { - "resources": { - "requests": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - }, - "limits": { - "cpu": "1", - "memory": "8Gi", - "additionalProperty": "additionalValue" - } - } - } - } - } - } - }, - "location": "northeurope", - "extendedLocation": { - "type": "CustomLocation", - "name": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.ExtendedLocation/customLocations/arclocation" - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "sku": { - "name": "vCore", - "tier": "GeneralPurpose", - "dev": true - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/sqlManagedInstances/testsqlManagedInstance", - "name": "testsqlManagedInstance", - "type": "Microsoft.AzureArcData/sqlManagedInstances" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerAvailabilityGroup.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerAvailabilityGroup.json deleted file mode 100644 index cc5b9f04f829..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerAvailabilityGroup.json +++ /dev/null @@ -1,62 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testSqlServerInstance", - "api-version": "2023-03-15-preview", - "sqlAvailabilityGroupName": "testAG", - "sqlServerAvailabilityGroupUpdate": { - "tags": { - "mytag": "myval1" - } - } - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testSqlServerInstance/sqlAvailabilityGroups/testAG", - "name": "testAG", - "type": "Microsoft.AzureArcData/sqlServerInstances/sqlAvailabilityGroups", - "properties": { - "availabilityGroupId": "00000000-1111-2222-3333-444444444444", - "availabilityGroupName": "testAG", - "configure": { - "endpointUrl": "TCP://mytest60-0.mytest60-svc:5022", - "availabilityModeDesc": "SYNCHRONOUS_COMMIT", - "failoverModeDesc": "EXTERNAL", - "sessionTimeout": 10, - "primaryRoleAllowConnectionsDesc": "ALL", - "secondaryRoleAllowConnectionsDesc": "ALL", - "createDate": null, - "modifyDate": null, - "backupPriority": 50, - "readOnlyRoutingUrl": null, - "readWriteRoutingUrl": null, - "seedingModeDesc": "AUTOMATIC" - }, - "state": { - "availabilityGroupReplicaRole": "SECONDARY", - "operationalStateDesc": "ONLINE", - "recoveryHealthDesc": "ONLINE_IN_PROGRESS", - "synchronizationHealthDesc": "HEALTHY", - "connectedStateDesc": "CONNECTED", - "lastConnectErrorDescription": "", - "lastConnectErrorTimestamp": "2022-05-05T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval1" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerDatabase.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerDatabase.json deleted file mode 100644 index a5acfeaf4b35..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerDatabase.json +++ /dev/null @@ -1,59 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testsqlManagedInstance", - "api-version": "2023-03-15-preview", - "databaseName": "testdb", - "sqlServerDatabaseUpdate": { - "tags": { - "mytag": "myval1" - } - } - }, - "responses": { - "200": { - "body": { - "location": "southeastasia", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/testSqlServerInstance/testsqlManagedInstance/databases/testdb", - "name": "testdb", - "type": "Microsoft.AzureArcData/sqlServerInstances/databases", - "properties": { - "collationName": "SQL_Latin1_General_CP1_CI_AS", - "databaseCreationDate": "2022-04-05T16:26:33.883Z", - "compatibilityLevel": 150, - "state": "Online", - "isReadOnly": true, - "recoveryMode": "Full", - "sizeMB": 150.00, - "spaceAvailableMB": 100.00, - "databaseOptions": { - "isAutoCloseOn": true, - "isAutoShrinkOn": true, - "isAutoCreateStatsOn": true, - "isAutoUpdateStatsOn": true, - "isMemoryOptimizationEnabled": true, - "isRemoteDataArchiveEnabled": true, - "isEncrypted": true, - "isTrustworthyOn": true - }, - "backupInformation": { - "lastFullBackup": "2022-05-05T16:26:33.883Z", - "lastLogBackup": "2022-05-10T16:26:33.883Z" - } - }, - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval1" - } - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerInstance.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerInstance.json deleted file mode 100644 index d27e55764e1b..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/examples/UpdateSqlServerInstance.json +++ /dev/null @@ -1,54 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlServerInstanceName": "testsqlServerInstance", - "api-version": "2023-03-15-preview", - "parameters": { - "tags": { - "mytag": "myval" - } - } - }, - "responses": { - "200": { - "body": { - "properties": { - "version": "SQL Server 2012", - "edition": "Developer", - "containerResourceId": "Resource id of hosting Arc Machine", - "createTime": "01/01/2020 01:01:01", - "patchLevel": "patchlevel", - "collation": "collation", - "currentVersion": "2012", - "instanceName": "name of instance", - "tcpDynamicPorts": "1433", - "tcpStaticPorts": "1433", - "productId": "sql id", - "vCore": "4", - "cores": "4", - "licenseType": "Free", - "azureDefenderStatusLastUpdated": "2020-01-02T17:18:19.1234567Z", - "azureDefenderStatus": "Protected", - "status": "Registered", - "hostType": "Physical Server" - }, - "location": "northeurope", - "systemData": { - "createdBy": "user1", - "createdByType": "User", - "createdAt": "2020-01-01T17:18:19.1234567Z", - "lastModifiedBy": "user2", - "lastModifiedByType": "User", - "lastModifiedAt": "2020-01-02T17:18:19.1234567Z" - }, - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureArcData/SqlServerInstances/testsqlServerInstance", - "name": "testsqlServerInstance", - "type": "Microsoft.AzureArcData/SqlServerInstances" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/failoverGroups.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/failoverGroups.json deleted file mode 100644 index 75accbf36a4b..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/failoverGroups.json +++ /dev/null @@ -1,157 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "paths": {}, - "definitions": { - "FailoverGroupListResult": { - "description": "A list of failover groups.", - "type": "object", - "properties": { - "value": { - "description": "Array of failover group results.", - "type": "array", - "items": { - "$ref": "#/definitions/FailoverGroupResource" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "FailoverGroupResource": { - "type": "object", - "description": "A failover group resource.", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/FailoverGroupProperties", - "description": "null", - "x-ms-client-flatten": false - } - }, - "required": [ - "properties" - ] - }, - "FailoverGroupProperties": { - "type": "object", - "description": "The properties of a failover group resource.", - "properties": { - "provisioningState": { - "type": "string", - "enum": [ - "Succeeded", - "Failed", - "Canceled", - "Accepted" - ], - "x-ms-enum": { - "name": "provisioningState", - "modelAsString": true - }, - "description": "The provisioning state of the failover group resource.", - "readOnly": true - }, - "partnerManagedInstanceId": { - "type": "string", - "description": "The resource ID of the partner SQL managed instance." - }, - "spec": { - "$ref": "#/definitions/FailoverGroupSpec", - "description": "The specifications of the failover group resource.", - "x-ms-client-flatten": false - }, - "status": { - "type": "object", - "description": "The status of the failover group custom resource." - } - }, - "additionalProperties": {}, - "required": [ - "partnerManagedInstanceId", - "spec" - ] - }, - "FailoverGroupSpec": { - "description": "The specifications of the failover group resource.", - "type": "object", - "properties": { - "sharedName": { - "type": "string", - "description": "The shared name of the failover group for this SQL managed instance. Both SQL managed instance and its partner have to use the same shared name." - }, - "sourceMI": { - "type": "string", - "description": "The name of the SQL managed instance with this failover group role." - }, - "partnerMI": { - "type": "string", - "description": "The name of the partner SQL managed instance." - }, - "partnerMirroringURL": { - "type": "string", - "description": "The mirroring endpoint URL of the partner SQL managed instance." - }, - "partnerMirroringCert": { - "type": "string", - "description": "The mirroring endpoint public certificate for the partner SQL managed instance. Only PEM format is supported." - }, - "partnerSyncMode": { - "type": "string", - "enum": [ - "async", - "sync" - ], - "x-ms-enum": { - "name": "failoverGroupPartnerSyncMode", - "modelAsString": true - }, - "default": "async", - "description": "The partner sync mode of the SQL managed instance." - }, - "role": { - "type": "string", - "enum": [ - "primary", - "secondary", - "force-primary-allow-data-loss", - "force-secondary" - ], - "x-ms-enum": { - "name": "instanceFailoverGroupRole", - "modelAsString": true - }, - "default": "primary", - "description": "The role of the SQL managed instance in this failover group." - } - }, - "additionalProperties": {}, - "required": [ - "role" - ] - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/operations.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/operations.json deleted file mode 100644 index 6ca87e7811ff..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/operations.json +++ /dev/null @@ -1,127 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "paths": {}, - "definitions": { - "Operation": { - "description": "Azure Data Services on Azure Arc operation definition.", - "type": "object", - "properties": { - "name": { - "description": "The name of the operation being performed on this particular object.", - "type": "string" - }, - "display": { - "$ref": "#/definitions/OperationDisplay", - "description": "The localized display information for this particular operation / action." - }, - "origin": { - "description": "The intended executor of the operation.", - "enum": [ - "user", - "system" - ], - "type": "string", - "readOnly": true, - "x-ms-enum": { - "name": "OperationOrigin", - "modelAsString": true - } - }, - "isDataAction": { - "description": "Indicates whether the operation is a data action", - "type": "boolean" - }, - "properties": { - "description": "Additional descriptions for the operation.", - "type": "object", - "additionalProperties": { - "type": "object" - }, - "readOnly": true, - "x-ms-client-flatten": false - } - }, - "required": [ - "name", - "display", - "isDataAction" - ] - }, - "OperationListResult": { - "description": "Result of the request to list Azure Data Services on Azure Arc operations.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/Operation" - }, - "x-ms-identifiers": [ - "name" - ], - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "OperationDisplay": { - "description": "Display metadata associated with the operation.", - "type": "object", - "properties": { - "provider": { - "description": "The localized friendly form of the resource provider name.", - "type": "string" - }, - "resource": { - "description": "The localized friendly form of the resource type related to this action/operation.", - "type": "string" - }, - "operation": { - "description": "The localized friendly name for the operation.", - "type": "string" - }, - "description": { - "description": "The localized friendly description for the operation.", - "type": "string" - } - }, - "required": [ - "provider", - "resource", - "operation", - "description" - ] - } - }, - "parameters": { - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request", - "x-ms-parameter-location": "client" - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/postgresInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/postgresInstances.json deleted file mode 100644 index a90939d13b8b..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/postgresInstances.json +++ /dev/null @@ -1,174 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "paths": {}, - "definitions": { - "PostgresInstanceSku": { - "description": "The resource model definition representing SKU for Azure Database for PostgresSQL - Azure Arc", - "type": "object", - "properties": { - "tier": { - "type": "string", - "enum": [ - "Hyperscale" - ], - "x-ms-enum": { - "name": "PostgresInstanceSkuTier", - "modelAsString": false - }, - "default": "Hyperscale", - "description": "This field is required to be implemented by the Resource Provider if the service has more than one tier." - } - }, - "allOf": [ - { - "$ref": "./common.json#/definitions/CommonSku" - } - ] - }, - "PostgresInstanceProperties": { - "description": "Postgres Instance properties.", - "type": "object", - "properties": { - "dataControllerId": { - "type": "string", - "description": "The data controller id" - }, - "admin": { - "type": "string", - "description": "The instance admin" - }, - "basicLoginInformation": { - "$ref": "./common.json#/definitions/BasicLoginInformation", - "description": "Username and password for basic authentication." - }, - "k8sRaw": { - "type": "object", - "description": "The raw kubernetes information" - }, - "lastUploadedDate": { - "type": "string", - "format": "date-time", - "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "The provisioning state of the Azure Arc-enabled PostgreSQL instance." - } - } - }, - "PostgresInstance": { - "description": "A Postgres Instance.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "extendedLocation": { - "$ref": "./common.json#/definitions/ExtendedLocation", - "description": "The extendedLocation of the resource." - }, - "properties": { - "$ref": "#/definitions/PostgresInstanceProperties", - "x-ms-client-flatten": false, - "description": "null" - }, - "sku": { - "$ref": "#/definitions/PostgresInstanceSku", - "description": "Resource sku." - } - }, - "required": [ - "properties" - ] - }, - "PostgresInstanceUpdate": { - "description": "An update to a Postgres Instance.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/PostgresInstanceProperties", - "x-ms-client-flatten": false - } - } - }, - "PostgresInstanceListResult": { - "description": "A list of PostgresInstance.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/PostgresInstance" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the Azure subscription", - "x-ms-parameter-location": "client" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Azure resource group", - "x-ms-parameter-location": "method" - }, - "location": { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "The Azure region to use for the request", - "x-ms-parameter-location": "method" - }, - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request", - "x-ms-parameter-location": "client" - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlAvailabilityGroups.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlAvailabilityGroups.json deleted file mode 100644 index 774cc70434cd..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlAvailabilityGroups.json +++ /dev/null @@ -1,141 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "paths": {}, - "definitions": { - "SqlAvailabilityGroup": { - "description": "A SqlAvailabilityGroup.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SqlAvailabilityGroupProperties", - "description": "null", - "x-ms-client-flatten": false - } - } - }, - "SqlAvailabilityGroupProperties": { - "description": "Properties of SqlAvailabilityGroup.", - "type": "object", - "properties": { - "availabilityGroupName": { - "description": "The name of the availability group.", - "type": "string" - }, - "availabilityGroupId": { - "description": "Id GUID of the availability group.", - "type": "string", - "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$" - }, - "instanceName": { - "description": "The name of the instance name which availability group primary is on.", - "type": "string" - }, - "collectionTimestamp": { - "description": "Timestamp for when the data was collected from the client machine.", - "type": "string", - "format": "date-time" - }, - "version": { - "type": "integer", - "description": "SQL Server availability group current version.", - "format": "int32" - }, - "basicFeatures": { - "type": "boolean", - "description": "SQL Server basic availability group." - }, - "dtcSupport": { - "type": "boolean", - "description": "SQL Server availability group DTC support enabled." - }, - "dbFailover": { - "type": "boolean", - "description": "SQL Server availability group failover for database health conditions." - }, - "isDistributed": { - "type": "boolean", - "description": "SQL Server distributed availability group." - }, - "clusterTypeDesc": { - "type": "string", - "description": "SQL Server availability group cluster type description" - }, - "requiredSynchronizedSecondariesCommit": { - "type": "integer", - "description": "Availability group required the number of synchronized secondary to commit." - }, - "isContained": { - "type": "boolean", - "description": "SQL Server availability group contained system databases." - } - }, - "required": [ - "availabilityGroupName", - "availabilityGroupId" - ] - }, - "SqlAvailabilityGroupUpdate": { - "description": "An update to a SQL Availability Group.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "SqlAvailabilityGroupListResult": { - "description": "A list of SqlAvailabilityGroup.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlAvailabilityGroup" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request", - "x-ms-parameter-location": "client" - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlManagedInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlManagedInstances.json deleted file mode 100644 index ac54208bfce0..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlManagedInstances.json +++ /dev/null @@ -1,307 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "paths": {}, - "definitions": { - "SqlManagedInstance": { - "description": "A SqlManagedInstance.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SqlManagedInstanceProperties", - "description": "null", - "x-ms-client-flatten": false - }, - "extendedLocation": { - "$ref": "./common.json#/definitions/ExtendedLocation", - "description": "The extendedLocation of the resource." - }, - "sku": { - "$ref": "#/definitions/SqlManagedInstanceSku", - "description": "Resource sku." - } - }, - "required": [ - "properties" - ] - }, - "SqlManagedInstanceSku": { - "description": "The resource model definition representing SKU for Azure Managed Instance - Azure Arc", - "type": "object", - "properties": { - "name": { - "type": "string", - "enum": [ - "vCore" - ], - "description": "The name of the SKU.", - "x-ms-enum": { - "name": "SqlManagedInstanceSkuName", - "modelAsString": false - } - }, - "tier": { - "type": "string", - "enum": [ - "GeneralPurpose", - "BusinessCritical" - ], - "x-ms-enum": { - "name": "SqlManagedInstanceSkuTier", - "modelAsString": false - }, - "default": "GeneralPurpose", - "description": "The pricing tier for the instance." - }, - "dev": { - "type": "boolean", - "default": true, - "description": "Whether dev/test is enabled. When the dev field is set to true, the resource is used for dev/test purpose. " - }, - "size": { - "type": "string", - "description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. " - }, - "family": { - "type": "string", - "description": "The SKU family" - }, - "capacity": { - "type": "integer", - "format": "int32", - "description": "The SKU capacity" - } - }, - "required": [ - "name" - ] - }, - "SqlManagedInstanceProperties": { - "description": "Properties of sqlManagedInstance.", - "type": "object", - "properties": { - "dataControllerId": { - "type": "string", - "description": "null" - }, - "admin": { - "type": "string", - "description": "The instance admin user" - }, - "startTime": { - "type": "string", - "description": "The instance start time" - }, - "endTime": { - "type": "string", - "description": "The instance end time" - }, - "k8sRaw": { - "$ref": "#/definitions/SqlManagedInstanceK8sRaw", - "description": "The raw kubernetes information" - }, - "basicLoginInformation": { - "$ref": "./common.json#/definitions/BasicLoginInformation", - "description": "Username and password for basic authentication." - }, - "lastUploadedDate": { - "type": "string", - "format": "date-time", - "description": "Last uploaded date from Kubernetes cluster. Defaults to current date time" - }, - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "The provisioning state of the Arc-enabled SQL Managed Instance resource." - }, - "activeDirectoryInformation": { - "description": "Active Directory information related to this SQL Managed Instance.", - "$ref": "#/definitions/ActiveDirectoryInformation" - }, - "licenseType": { - "type": "string", - "enum": [ - "BasePrice", - "LicenseIncluded", - "DisasterRecovery" - ], - "x-ms-enum": { - "name": "arcSqlManagedInstanceLicenseType", - "modelAsString": true - }, - "default": "BasePrice", - "description": "The license type to apply for this managed instance." - }, - "clusterId": { - "type": "string", - "description": "If a CustomLocation is provided, this contains the ARM id of the connected cluster the custom location belongs to." - }, - "extensionId": { - "type": "string", - "description": "If a CustomLocation is provided, this contains the ARM id of the extension the custom location belongs to." - } - } - }, - "SqlManagedInstanceUpdate": { - "description": "An update to a SQL Managed Instance.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "SqlManagedInstanceK8sRaw": { - "type": "object", - "description": "The raw kubernetes information.", - "properties": { - "spec": { - "$ref": "#/definitions/SqlManagedInstanceK8sSpec" - } - }, - "additionalProperties": {} - }, - "SqlManagedInstanceK8sSpec": { - "type": "object", - "description": "The kubernetes spec information.", - "properties": { - "scheduling": { - "$ref": "#/definitions/K8sScheduling" - }, - "replicas": { - "type": "integer", - "format": "int32", - "description": "This option specifies the number of SQL Managed Instance replicas that will be deployed in your Kubernetes cluster for high availability purposes. If sku.tier is BusinessCritical, allowed values are '2' or '3' with default of '3'. If sku.tier is GeneralPurpose, replicas must be '1'." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "K8sScheduling": { - "type": "object", - "description": "The kubernetes scheduling information.", - "properties": { - "default": { - "$ref": "#/definitions/K8sSchedulingOptions" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "K8sSchedulingOptions": { - "type": "object", - "description": "The kubernetes scheduling options. It describes restrictions used to help Kubernetes select appropriate nodes to host the database service", - "properties": { - "resources": { - "$ref": "#/definitions/K8sResourceRequirements" - } - }, - "additionalProperties": { - "type": "object" - } - }, - "K8sResourceRequirements": { - "type": "object", - "description": "The kubernetes resource limits and requests used to restrict or reserve resource usage.", - "properties": { - "requests": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Requests for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'." - }, - "limits": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Limits for a kubernetes resource type (e.g 'cpu', 'memory'). The 'cpu' request must be less than or equal to 'cpu' limit. Default 'cpu' is 2, minimum is 1. Default 'memory' is '4Gi', minimum is '2Gi. If sku.tier is GeneralPurpose, maximum 'cpu' is 24 and maximum 'memory' is '128Gi'." - } - }, - "additionalProperties": { - "type": "object" - } - }, - "KeytabInformation": { - "type": "object", - "description": "Keytab used for authenticate with Active Directory.", - "properties": { - "keytab": { - "type": "string", - "description": "A base64-encoded keytab.", - "x-ms-mutability": [ - "create", - "update" - ], - "x-ms-secret": true - } - } - }, - "ActiveDirectoryInformation": { - "type": "object", - "description": "Active Directory information that related to the resource.", - "properties": { - "keytabInformation": { - "description": "Keytab information that is used for the Sql Managed Instance when Active Directory authentication is used.", - "$ref": "#/definitions/KeytabInformation" - } - } - }, - "SqlManagedInstanceListResult": { - "description": "A list of SqlManagedInstance.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlManagedInstance" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request", - "x-ms-parameter-location": "client" - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerAvailabilityGroups.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerAvailabilityGroups.json deleted file mode 100644 index 95c7a8bd0890..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerAvailabilityGroups.json +++ /dev/null @@ -1,1188 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/sqlAvailabilityGroups/{sqlAvailabilityGroupName}": { - "put": { - "tags": [ - "SqlServerAvailabilityGroups" - ], - "operationId": "SqlServerAvailabilityGroups_Create", - "description": "Creates or replaces an Arc Sql Server Availability Group.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "sqlServerAvailabilityGroupResource", - "description": "The request body for availability group resource.", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/SqlServerAvailabilityGroupResource" - } - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlServerAvailabilityGroupResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create a Arc Sql Server availability group.": { - "$ref": "./examples/CreateOrUpdateArcSqlServerAvailabilityGroup.json" - } - } - }, - "delete": { - "tags": [ - "SqlServerAvailabilityGroups" - ], - "operationId": "SqlServerAvailabilityGroups_Delete", - "description": "Deletes an Arc Sql Server availability group resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the availability group." - }, - "204": { - "description": "The specified availability group does not exist." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Deletes a availability group resource": { - "$ref": "./examples/DeleteArcSqlServerAvailabilityGroup.json" - } - } - }, - "get": { - "tags": [ - "SqlServerAvailabilityGroups" - ], - "operationId": "SqlServerAvailabilityGroups_Get", - "description": "Retrieves an Arc Sql Server availability group.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlServerAvailabilityGroupResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Retrieves an Arc Sql Server availability group resource.": { - "$ref": "./examples/GetArcSqlServerAvailabilityGroup.json" - } - } - }, - "patch": { - "tags": [ - "SqlServerAvailabilityGroups" - ], - "description": "Updates an existing Availability Group.", - "operationId": "SqlServerAvailabilityGroups_Update", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "sqlServerAvailabilityGroupUpdate", - "in": "body", - "description": "The requested server availability group resource state.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlServerAvailabilityGroupUpdate" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated the Availability Group.", - "schema": { - "$ref": "#/definitions/SqlServerAvailabilityGroupResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update a availability group.": { - "$ref": "./examples/UpdateSqlServerAvailabilityGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/sqlAvailabilityGroups": { - "get": { - "tags": [ - "SqlServerAvailabilityGroups" - ], - "operationId": "SqlServerAvailabilityGroups_List", - "summary": "List the availability group associated with the given Arc Sql Server.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ArcSqlServerAvailabilityGroupListResult" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all availability groups associated with an Arc Enabled Sql server.": { - "$ref": "./examples/ListBySqlServerInstanceAvailabilityGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/{sqlAvailabilityGroupName}/sqlServerInstances/{sqlServerInstanceName}": { - "put": { - "tags": [ - "SqlAvailabilityGroupReplicas" - ], - "operationId": "SqlAvailabilityGroupReplicas_Create", - "description": "Creates or replaces an Arc Sql Availability Group Replica.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "sqlAvailabilityGroupReplicaResource", - "description": "The request body for availability group replica resource.", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/SqlAvailabilityGroupReplicaResource" - } - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlAvailabilityGroupReplicaResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create a Arc Sql Server availability group replica.": { - "$ref": "./examples/CreateOrUpdateArcSqlAvailabilityGroupReplica.json" - } - } - }, - "delete": { - "tags": [ - "SqlAvailabilityGroupReplicas" - ], - "operationId": "SqlAvailabilityGroupReplicas_Delete", - "description": "Deletes an Arc Sql availability group replica resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the availability group." - }, - "204": { - "description": "The specified availability group does not exist." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Deletes a availability group resource": { - "$ref": "./examples/DeleteArcSqlAvailabilityGroupReplica.json" - } - } - }, - "get": { - "tags": [ - "SqlAvailabilityGroupReplicas" - ], - "operationId": "SqlAvailabilityGroupReplicas_Get", - "description": "Retrieves an Arc Sql availability group replica.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlAvailabilityGroupReplicaResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Retrieves an Arc Sql Server availability group resource.": { - "$ref": "./examples/GetArcSqlAvailabilityGroupReplica.json" - } - } - }, - "patch": { - "tags": [ - "SqlAvailabilityGroupReplicas" - ], - "description": "Updates an existing Availability Group Replica.", - "operationId": "SqlAvailabilityGroupReplicas_Update", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "sqlAvailabilityGroupReplicaUpdate", - "in": "body", - "description": "The requested availability group replica resource state.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlAvailabilityGroupReplicaUpdate" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated the availability group replica.", - "schema": { - "$ref": "#/definitions/SqlAvailabilityGroupReplicaResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update a availability group replica.": { - "$ref": "./examples/UpdateSqlAvailabilityGroupReplica.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/{sqlAvailabilityGroupName}/sqlServerInstances": { - "get": { - "tags": [ - "SqlAvailabilityGroupReplicas" - ], - "operationId": "SqlAvailabilityGroupReplicas_List", - "summary": "List the Availability Group Replica associated with the given Arc Sql AG.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ArcSqlAvailabilityGroupReplicaListResult" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all availability group replicas associated with the availability groups .": { - "$ref": "./examples/ListBySqlAvailabilityGroupReplica.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/{sqlAvailabilityGroupName}/databases/{sqlAvailabilityGroupDatabaseName}": { - "put": { - "tags": [ - "SqlAvailabilityGroupDatabases" - ], - "operationId": "SqlAvailabilityGroupDatabases_Create", - "description": "Creates or update database in an Arc Sql Availability Group.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "sqlAvailabilityGroupDatabaseResource", - "description": "The request body for availability group databases resource.", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/SqlAvailabilityGroupDatabaseResource" - } - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupDatabaseName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlAvailabilityGroupDatabaseResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create a Arc availability group database.": { - "$ref": "./examples/CreateOrUpdateArcSqlAvailabilityGroupDatabase.json" - } - } - }, - "delete": { - "tags": [ - "SqlAvailabilityGroupDatabases" - ], - "operationId": "SqlAvailabilityGroupDatabases_Delete", - "description": "Deletes an Arc Sql availability group database resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupDatabaseName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the database of the availability group." - }, - "204": { - "description": "The specified database of availability group does not exist." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Deletes an Arc Sql availability group database resource": { - "$ref": "./examples/DeleteArcSqlAvailabilityGroupDatabase.json" - } - } - }, - "get": { - "tags": [ - "SqlAvailabilityGroupDatabases" - ], - "operationId": "SqlAvailabilityGroupDatabases_Get", - "description": "Retrieves an Arc Sql availability group database resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupDatabaseName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlAvailabilityGroupDatabaseResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Retrieves an Arc Sql Server availability group database resource.": { - "$ref": "./examples/GetArcSqlAvailabilityGroupDatabase.json" - } - } - }, - "patch": { - "tags": [ - "SqlAvailabilityGroupDatabases" - ], - "description": "Updates an existing Availability Group Database.", - "operationId": "SqlAvailabilityGroupDatabases_Update", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupDatabaseName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "sqlAvailabilityGroupDatabaseUpdate", - "in": "body", - "description": "The update availability group database resource.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlAvailabilityGroupDatabaseUpdate" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated the availability group database.", - "schema": { - "$ref": "#/definitions/SqlAvailabilityGroupDatabaseResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update a availability group replica.": { - "$ref": "./examples/UpdateSqlAvailabilityGroupDatabase.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlAvailabilityGroups/{sqlAvailabilityGroupName}/databases": { - "get": { - "tags": [ - "SqlAvailabilityGroupDatabases" - ], - "operationId": "SqlAvailabilityGroupDatabases_List", - "summary": "List the Availability Group Databases associated with the given Arc Sql AG.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlAvailabilityGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ArcSqlAvailabilityGroupDatabasesListResult" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all availability group databases associated with the availability groups .": { - "$ref": "./examples/ListBySqlAvailabilityGroupDatabase.json" - } - } - } - } - }, - "definitions": { - "AvailabilityGroupConfigure": { - "description": "The specifications of the availability group replica configuration", - "type": "object", - "properties": { - "endpointUrl": { - "type": "string", - "description": "Mirroring endpoint URL of availability group replica" - }, - "availabilityModeDesc": { - "type": "string", - "description": "Availability Synchronization mode description of availability group replica." - }, - "failoverModeDesc": { - "type": "string", - "description": "failover mode description of the availability group replica." - }, - "sessionTimeout": { - "type": "integer", - "description": "The time-out period of availability group session replica, in seconds.", - "format": "int32" - }, - "primaryRoleAllowConnectionsDesc": { - "type": "string", - "description": "Allowed the connections for primary role of the availability group replica." - }, - "secondaryRoleAllowConnectionsDesc": { - "type": "string", - "description": "Allowed the connections for secondary role of availability group replica." - }, - "createDate": { - "type": "string", - "description": "Date that the replica was created.", - "format": "date-time" - }, - "modifyDate": { - "type": "string", - "description": "Date that the replica was modified.", - "format": "date-time" - }, - "backupPriority": { - "type": "integer", - "description": "Represents the user-specified priority for performing backups on this replica relative to the other replicas in the same availability group.", - "format": "int32" - }, - "readOnlyRoutingUrl": { - "type": "string", - "description": "Connectivity endpoint (URL) of the read only availability replica." - }, - "readWriteRoutingUrl": { - "type": "string", - "description": "Connectivity endpoint (URL) of the read write availability replica." - }, - "seedingModeDesc": { - "type": "string", - "description": "Describes seeding mode." - } - } - }, - "AvailabilityGroupState": { - "description": "The specifications of the availability group state", - "type": "object", - "properties": { - "availabilityGroupReplicaRole": { - "type": "string", - "description": "Role description of the availability group replica." - }, - "operationalStateDesc": { - "type": "string", - "description": "Operation state description of the availability group replica" - }, - "recoveryHealthDesc": { - "type": "string", - "description": "Recovery health description of the availability group replica." - }, - "synchronizationHealthDesc": { - "type": "string", - "description": "Synchronization health description of the availability group replica." - }, - "connectedStateDesc": { - "type": "string", - "description": "Connected state description of the availability group replica." - }, - "lastConnectErrorDescription": { - "type": "string", - "description": "Last connect error description of the availability group replica." - }, - "lastConnectErrorTimestamp": { - "type": "string", - "description": "Last connect error time stamp of the availability group replica.", - "format": "date-time" - } - } - }, - "ArcSqlServerAvailabilityGroupListResult": { - "description": "A list of Arc Sql Server Availability Group.", - "type": "object", - "properties": { - "value": { - "description": "Array of Arc Sql Server Availability Group.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlServerAvailabilityGroupResource" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "SqlServerAvailabilityGroupResource": { - "type": "object", - "description": "Arc Sql Server Availability Group", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SqlServerAvailabilityGroupResourceProperties", - "description": "Properties of Arc Sql Server availability group", - "x-ms-client-flatten": false - } - }, - "required": [ - "properties" - ] - }, - "SqlServerAvailabilityGroupResourceProperties": { - "type": "object", - "description": "The properties of Arc Sql Server availability group resource", - "properties": { - "availabilityGroupId": { - "type": "string", - "description": "ID GUID of the availability group.", - "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$" - }, - "availabilityGroupName": { - "type": "string", - "description": "the availability group name." - }, - "configure": { - "$ref": "#/definitions/AvailabilityGroupConfigure", - "description": "null", - "x-ms-client-flatten": false - }, - "state": { - "$ref": "#/definitions/AvailabilityGroupState", - "description": "null", - "x-ms-client-flatten": false - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the Arc-enabled SQL Server availability group resource.", - "readOnly": true - } - }, - "required": [ - "availabilityGroupId" - ] - }, - "SqlServerAvailabilityGroupUpdate": { - "description": "An update to availability group resource.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/SqlServerAvailabilityGroupResourceProperties", - "description": "The Server Availability Group's properties", - "x-ms-client-flatten": false - } - } - }, - "ArcSqlAvailabilityGroupReplicaListResult": { - "description": "A list of Arc Sql Availability Group Replica.", - "type": "object", - "properties": { - "value": { - "description": "Array of Arc Sql Availability Group Replica.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlAvailabilityGroupReplicaResource" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "SqlAvailabilityGroupReplicaResource": { - "type": "object", - "description": "Arc Sql Server Availability Group", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SqlAvailabilityGroupReplicaResourceProperties", - "description": "Properties of Arc Sql Availability Group Replica", - "x-ms-client-flatten": false - } - }, - "required": [ - "properties" - ] - }, - "SqlAvailabilityGroupReplicaResourceProperties": { - "type": "object", - "description": "The properties of Arc Sql availability group replica resource", - "properties": { - "replicaId": { - "type": "string", - "description": "ID GUID of the availability group.", - "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$" - }, - "replicaName": { - "type": "string", - "description": "the replica name." - }, - "configure": { - "$ref": "#/definitions/AvailabilityGroupConfigure", - "description": "null", - "x-ms-client-flatten": false - }, - "state": { - "$ref": "#/definitions/AvailabilityGroupState", - "description": "null", - "x-ms-client-flatten": false - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the Arc-enabled SQL Server availability group resource.", - "readOnly": true - } - } - }, - "SqlAvailabilityGroupReplicaUpdate": { - "description": "An update to Availability Group Replica resource.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/SqlAvailabilityGroupReplicaResourceProperties", - "description": "The Availability Group Replica's properties", - "x-ms-client-flatten": false - } - } - }, - "ArcSqlAvailabilityGroupDatabasesListResult": { - "description": "A list of Arc Sql Availability Group Databases.", - "type": "object", - "properties": { - "value": { - "description": "Array of Arc Sql Availability Group Database.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlAvailabilityGroupDatabaseResource" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "SqlAvailabilityGroupDatabaseResource": { - "type": "object", - "description": "Arc Sql Server Availability Group Database", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SqlAvailabilityGroupMultiDatabaseReplicaResourceProperties", - "description": "Properties of Arc Sql Availability Group Multiple Database Replica", - "x-ms-client-flatten": false - } - }, - "required": [ - "properties" - ] - }, - "SqlAvailabilityGroupMultiDatabaseReplicaResourceProperties": { - "type": "object", - "description": "The properties of Arc Sql availability group multiple database replica resource", - "properties": { - "groupDatabaseId": { - "type": "string", - "description": "ID GUID of the database for availability group.", - "pattern": "^[A-Za-z0-9]{8}-([A-Za-z0-9]{4}-){3}[A-Za-z0-9]{12}$" - }, - "value": { - "description": "Array of Arc Sql Availability Group Database Replicas.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlAvailabilityGroupDatabaseReplicaResourceProperties" - } - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the Arc-enabled SQL Server availability group resource.", - "readOnly": true - } - } - }, - "SqlAvailabilityGroupDatabaseReplicaResourceProperties": { - "type": "object", - "description": "The properties of Arc Sql availability group database replica resource", - "properties": { - "replicaName": { - "type": "string", - "description": "the database replica name." - }, - "isLocal": { - "type": "boolean", - "description": "Whether the availability database is local." - }, - "isPrimaryReplica": { - "type": "boolean", - "description": "Returns 1 if the replica is primary, or 0 if it is a secondary replica." - }, - "synchronizationStateDesc": { - "type": "string", - "description": "Description of the data-movement state." - }, - "isCommitParticipant": { - "type": "boolean", - "description": "Whether this replica is transaction committer." - }, - "synchronizationHealthDesc": { - "type": "string", - "description": "Description of the health of database." - }, - "databaseStateDesc": { - "type": "string", - "description": "Description of the database state of the availability replica." - }, - "isSuspended": { - "type": "boolean", - "description": "Whether this data movement is suspended." - }, - "suspendReasonDesc": { - "type": "string", - "description": "Description of the database suspended state reason." - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the Arc-enabled SQL Server availability group resource.", - "readOnly": true - } - } - }, - "SqlAvailabilityGroupDatabaseUpdate": { - "description": "An update to Availability Group Database Replica resource.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/SqlAvailabilityGroupMultiDatabaseReplicaResourceProperties", - "description": "The Availability Group Replica's properties", - "x-ms-client-flatten": false - } - } - } - }, - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the Azure subscription", - "x-ms-parameter-location": "client" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Azure resource group", - "x-ms-parameter-location": "method" - }, - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request", - "x-ms-parameter-location": "client" - }, - "sqlServerInstanceName": { - "name": "sqlServerInstanceName", - "description": "Name of SQL Server Instance", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "sqlAvailabilityGroupDatabaseName": { - "name": "sqlAvailabilityGroupDatabaseName", - "description": "Name of SQL Availability Group Database", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "sqlAvailabilityGroupName": { - "name": "sqlAvailabilityGroupName", - "description": "Name of SQL Availability Group", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerDatabases.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerDatabases.json deleted file mode 100644 index a978ab77b92a..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerDatabases.json +++ /dev/null @@ -1,490 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases/{databaseName}": { - "put": { - "tags": [ - "SqlServerDatabases" - ], - "operationId": "SqlServerDatabases_Create", - "description": "Creates or replaces an Arc Sql Server Database.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "sqlServerDatabaseResource", - "description": "The request body for database resource.", - "required": true, - "in": "body", - "schema": { - "$ref": "#/definitions/SqlServerDatabaseResource" - } - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/databaseName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlServerDatabaseResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Create a Arc Sql Server database.": { - "$ref": "./examples/CreateOrUpdateArcSqlServerDatabase.json" - } - } - }, - "delete": { - "tags": [ - "SqlServerDatabases" - ], - "operationId": "SqlServerDatabases_Delete", - "description": "Deletes an Arc Sql Server database resource.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/databaseName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the database." - }, - "204": { - "description": "The specified database does not exist." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Deletes a database resource": { - "$ref": "./examples/DeleteArcSqlServerDatabase.json" - } - } - }, - "get": { - "tags": [ - "SqlServerDatabases" - ], - "operationId": "SqlServerDatabases_Get", - "description": "Retrieves an Arc Sql Server database.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/databaseName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlServerDatabaseResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Retrieves an Arc Sql Server database resource.": { - "$ref": "./examples/GetArcSqlServerDatabase.json" - } - } - }, - "patch": { - "tags": [ - "SqlServerDatabases" - ], - "description": "Updates an existing database.", - "operationId": "SqlServerDatabases_Update", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/databaseName" - }, - { - "$ref": "#/parameters/apiVersion" - }, - { - "name": "sqlServerDatabaseUpdate", - "in": "body", - "description": "The requested database resource state.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlServerDatabaseUpdate" - } - } - ], - "responses": { - "200": { - "description": "Successfully updated the database.", - "schema": { - "$ref": "#/definitions/SqlServerDatabaseResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Update a database.": { - "$ref": "./examples/UpdateSqlServerDatabase.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureArcData/sqlServerInstances/{sqlServerInstanceName}/databases": { - "get": { - "tags": [ - "SqlServerDatabases" - ], - "operationId": "SqlServerDatabases_List", - "summary": "List the databases associated with the given Arc Sql Server.", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/sqlServerInstanceName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/ArcSqlServerDatabaseListResult" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "./common.json#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all databases associated with an Arc Enabled Sql server.": { - "$ref": "./examples/ListBySqlServerInstanceDatabase.json" - } - } - } - } - }, - "definitions": { - "ArcSqlServerDatabaseListResult": { - "description": "A list of Arc Sql Server database.", - "type": "object", - "properties": { - "value": { - "description": "Array of Arc Sql Server database.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlServerDatabaseResource" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, - "SqlServerDatabaseResource": { - "type": "object", - "description": "Arc Sql Server database", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SqlServerDatabaseResourceProperties", - "description": "Properties of Arc Sql Server database", - "x-ms-client-flatten": false - } - }, - "required": [ - "properties" - ] - }, - "SqlServerDatabaseResourceProperties": { - "type": "object", - "description": "The properties of Arc Sql Server database resource", - "properties": { - "collationName": { - "description": "Collation of the database.", - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ] - }, - "databaseCreationDate": { - "format": "date-time", - "description": "Creation date of the database.", - "type": "string" - }, - "compatibilityLevel": { - "type": "integer", - "minimum": 80, - "maximum": 200, - "format": "int32", - "description": "Compatibility level of the database" - }, - "sizeMB": { - "type": "number", - "format": "float", - "description": "Size of the database." - }, - "spaceAvailableMB": { - "type": "number", - "format": "float", - "description": "Space left of the database." - }, - "state": { - "description": "State of the database.", - "enum": [ - "Online", - "Restoring", - "Recovering", - "RecoveryPending", - "Suspect", - "Emergency", - "Offline", - "Copying", - "OfflineSecondary" - ], - "type": "string", - "x-ms-enum": { - "name": "DatabaseState", - "modelAsString": true - } - }, - "isReadOnly": { - "type": "boolean", - "description": "Whether the database is read only or not." - }, - "recoveryMode": { - "description": "Status of the database.", - "enum": [ - "Full", - "Bulk-logged", - "Simple" - ], - "type": "string", - "x-ms-enum": { - "name": "RecoveryMode", - "modelAsString": true - } - }, - "databaseOptions": { - "type": "object", - "description": "List of features that are enabled for the database", - "properties": { - "isAutoCloseOn": { - "type": "boolean" - }, - "isAutoShrinkOn": { - "type": "boolean" - }, - "isAutoCreateStatsOn": { - "type": "boolean" - }, - "isAutoUpdateStatsOn": { - "type": "boolean" - }, - "isRemoteDataArchiveEnabled": { - "type": "boolean" - }, - "isMemoryOptimizationEnabled": { - "type": "boolean" - }, - "isEncrypted": { - "type": "boolean" - }, - "isTrustworthyOn": { - "type": "boolean" - } - } - }, - "backupInformation": { - "type": "object", - "properties": { - "lastFullBackup": { - "format": "date-time", - "description": "Date time of last full backup.", - "type": "string" - }, - "lastLogBackup": { - "format": "date-time", - "description": "Date time of last log backup.", - "type": "string" - } - } - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the Arc-enabled SQL Server database resource.", - "readOnly": true - } - } - }, - "SqlServerDatabaseUpdate": { - "description": "An update to database resource.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "$ref": "#/definitions/SqlServerDatabaseResourceProperties", - "description": "The data controller's properties", - "x-ms-client-flatten": false - } - } - } - }, - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the Azure subscription", - "x-ms-parameter-location": "client" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the Azure resource group", - "x-ms-parameter-location": "method" - }, - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request", - "x-ms-parameter-location": "client" - }, - "sqlServerInstanceName": { - "name": "sqlServerInstanceName", - "description": "Name of SQL Server Instance", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "databaseName": { - "name": "databaseName", - "description": "Name of the database", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerInstances.json b/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerInstances.json deleted file mode 100644 index f3c60ffc6632..000000000000 --- a/specification/azurearcdata/resource-manager/Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerInstances.json +++ /dev/null @@ -1,246 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2023-03-15-preview", - "title": "AzureArcDataManagementClient", - "description": "The AzureArcData management API provides a RESTful set of web APIs to manage Azure Data Services on Azure Arc Resources." - }, - "paths": {}, - "definitions": { - "SqlServerInstance": { - "description": "A SqlServerInstance.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SqlServerInstanceProperties", - "description": "null", - "x-ms-client-flatten": false - } - } - }, - "SqlServerInstanceProperties": { - "description": "Properties of SqlServerInstance.", - "type": "object", - "properties": { - "version": { - "type": "string", - "description": "SQL Server version.", - "enum": [ - "SQL Server 2012", - "SQL Server 2014", - "SQL Server 2016", - "SQL Server 2017", - "SQL Server 2019", - "SQL Server 2022", - "Unknown" - ], - "x-ms-enum": { - "name": "sqlVersion", - "modelAsString": true - } - }, - "edition": { - "type": "string", - "description": "SQL Server edition.", - "enum": [ - "Evaluation", - "Enterprise", - "Standard", - "Web", - "Developer", - "Express", - "Business Intelligence" - ], - "x-ms-enum": { - "name": "editionType", - "modelAsString": true - } - }, - "containerResourceId": { - "type": "string", - "description": "ARM Resource id of the container resource (Azure Arc for Servers)." - }, - "createTime": { - "type": "string", - "description": "The time when the resource was created.", - "readOnly": true - }, - "vCore": { - "type": "string", - "description": "The number of logical processors used by the SQL Server instance." - }, - "cores": { - "type": "string", - "description": "The number of total cores of the Operating System Environment (OSE) hosting the SQL Server instance." - }, - "status": { - "type": "string", - "description": "The cloud connectivity status.", - "enum": [ - "Connected", - "Disconnected", - "Registered", - "Unknown" - ], - "x-ms-enum": { - "name": "ConnectionStatus", - "modelAsString": true - } - }, - "patchLevel": { - "type": "string", - "description": "SQL Server update level." - }, - "collation": { - "type": "string", - "description": "SQL Server collation." - }, - "currentVersion": { - "type": "string", - "description": "SQL Server current version." - }, - "instanceName": { - "type": "string", - "description": "SQL Server instance name." - }, - "tcpDynamicPorts": { - "type": "string", - "description": "Dynamic TCP ports used by SQL Server." - }, - "tcpStaticPorts": { - "type": "string", - "description": "Static TCP ports used by SQL Server." - }, - "productId": { - "type": "string", - "description": "SQL Server product ID." - }, - "licenseType": { - "type": "string", - "description": "SQL Server license type.", - "enum": [ - "Undefined", - "Free", - "HADR", - "ServerCAL", - "LicenseOnly", - "PAYG", - "Paid" - ], - "x-ms-enum": { - "name": "arcSqlServerLicenseType", - "modelAsString": true - } - }, - "azureDefenderStatusLastUpdated": { - "type": "string", - "format": "date-time", - "description": "Timestamp of last Azure Defender status update." - }, - "azureDefenderStatus": { - "type": "string", - "description": "Status of Azure Defender.", - "enum": [ - "Protected", - "Unprotected", - "Unknown" - ], - "x-ms-enum": { - "name": "defenderStatus", - "modelAsString": true - } - }, - "provisioningState": { - "type": "string", - "description": "The provisioning state of the Arc-enabled SQL Server resource.", - "readOnly": true - }, - "hostType": { - "type": "string", - "description": "Type of host for Azure Arc SQL Server", - "enum": [ - "Azure Virtual Machine", - "Azure VMWare Virtual Machine", - "Azure Kubernetes Service", - "AWS VMWare Virtual Machine", - "AWS Kubernetes Service", - "GCP VMWare Virtual Machine", - "GCP Kubernetes Service", - "Container", - "Virtual Machine", - "Physical Server", - "AWS Virtual Machine", - "GCP Virtual Machine", - "Other" - ], - "x-ms-enum": { - "name": "hostType", - "modelAsString": true - } - } - }, - "required": [ - "containerResourceId", - "status" - ] - }, - "SqlServerInstanceUpdate": { - "description": "An update to a SQL Server Instance.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "SqlServerInstanceListResult": { - "description": "A list of SqlServerInstance.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlServerInstance" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - } - }, - "parameters": { - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "The API version to use for the request", - "x-ms-parameter-location": "client" - } - }, - "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" - } - } - } -} diff --git a/specification/azurearcdata/resource-manager/readme.md b/specification/azurearcdata/resource-manager/readme.md index 3913d6dd2062..95ecebe8dc39 100644 --- a/specification/azurearcdata/resource-manager/readme.md +++ b/specification/azurearcdata/resource-manager/readme.md @@ -27,29 +27,9 @@ These are the global settings for the azurearcdata. ``` yaml openapi-type: arm openapi-subtype: rpaas -tag: package-preview-2023-03 +tag: package-preview-2023-01 ``` - -### Tag: package-preview-2023-03 - -These settings apply only when `--tag=package-preview-2023-03` is specified on the command line. - -```yaml $(tag) == 'package-preview-2023-03' -input-file: - - Microsoft.AzureArcData/preview/2023-03-15-preview/activeDirectoryConnectors.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/azurearcdata.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/common.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/dataControllers.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/failoverGroups.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/operations.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/postgresInstances.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/sqlManagedInstances.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerDatabases.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerInstances.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/sqlAvailabilityGroups.json - - Microsoft.AzureArcData/preview/2023-03-15-preview/sqlServerAvailabilityGroups.json -``` ### Tag: package-preview-2023-01 These settings apply only when `--tag=package-preview-2023-01` is specified on the command line. From c7daa3d35baaaabece0dbc6f731eadbe426973b9 Mon Sep 17 00:00:00 2001 From: Haoling Dong <87355844+haolingdong-msft@users.noreply.github.com> Date: Fri, 12 May 2023 15:21:30 +0800 Subject: [PATCH 66/79] Create readme.java.md for SelfHelp (#23950) --- specification/help/resource-manager/readme.java.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 specification/help/resource-manager/readme.java.md diff --git a/specification/help/resource-manager/readme.java.md b/specification/help/resource-manager/readme.java.md new file mode 100644 index 000000000000..8b63b893ba8c --- /dev/null +++ b/specification/help/resource-manager/readme.java.md @@ -0,0 +1,7 @@ +## Java + +These settings apply only when `--java` is specified on the command line. + +``` yaml $(java) +service-name: Self Help +``` From 1cbe41c8eea04f0893c42623e74c9461b30a0cdf Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Fri, 12 May 2023 12:16:54 -0700 Subject: [PATCH 67/79] TypeSpec CI Pipeline (#23944) - Validates all TypeSpec specs in the repo --- eng/pipelines/templates/steps/typespec-ci.yml | 33 ++++++++++++ eng/pipelines/typespec-ci.yml | 54 +++++++++++++++++++ 2 files changed, 87 insertions(+) create mode 100644 eng/pipelines/templates/steps/typespec-ci.yml create mode 100644 eng/pipelines/typespec-ci.yml diff --git a/eng/pipelines/templates/steps/typespec-ci.yml b/eng/pipelines/templates/steps/typespec-ci.yml new file mode 100644 index 000000000000..cdf39118c6cc --- /dev/null +++ b/eng/pipelines/templates/steps/typespec-ci.yml @@ -0,0 +1,33 @@ +parameters: +- name: Folder + type: string +- name: DisplayName + type: string + +steps: +- script: | + # Log commands before running + set -x + + exit_code=0 + + pushd ${{parameters.Folder}} + npx tsp compile . || exit_code=1 + # Format parent folder to include shared files (disabled until formatting diffs are fixed) + # npx tsp format ../**/*.tsp + popd + + # If any files are added, changed, or deleted, print diff and return error + if [ -n "$(git status --porcelain)" ]; then + git status + git diff + exit_code=1 + fi + + # Revert any changes + git restore . + git clean -df + + exit $exit_code + displayName: ${{parameters.DisplayName}} + condition: succeededOrFailed() diff --git a/eng/pipelines/typespec-ci.yml b/eng/pipelines/typespec-ci.yml new file mode 100644 index 000000000000..244e8c42b465 --- /dev/null +++ b/eng/pipelines/typespec-ci.yml @@ -0,0 +1,54 @@ +jobs: +- job: TypeSpecCI + pool: + name: azsdk-pool-mms-ubuntu-2204-general + vmImage: ubuntu-22.04 + + steps: + - script: npm ci + displayName: npm ci + + - template: templates/steps/typespec-ci.yml + parameters: + Folder: specification/contosowidgetmanager/Contoso.WidgetManager + DisplayName: Contoso.WidgetManager + + - template: templates/steps/typespec-ci.yml + parameters: + Folder: specification/cognitiveservices/AnomalyDetector + DisplayName: AnomalyDetector + + - template: templates/steps/typespec-ci.yml + parameters: + Folder: specification/cognitiveservices/ContentSafety + DisplayName: ContentSafety + + - template: templates/steps/typespec-ci.yml + parameters: + Folder: specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype + DisplayName: healthinsights.oncophenotype + + - template: templates/steps/typespec-ci.yml + parameters: + Folder: specification/cognitiveservices/HealthInsights/healthinsights.openapi + DisplayName: healthinsights.openapi + + - template: templates/steps/typespec-ci.yml + parameters: + Folder: specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher + DisplayName: healthinsights.trialmatcher + + - template: templates/steps/typespec-ci.yml + parameters: + Folder: specification/cognitiveservices/OpenAI.Authoring + DisplayName: OpenAI.Authoring + + - template: templates/steps/typespec-ci.yml + parameters: + Folder: specification/cognitiveservices/OpenAI.Inference + DisplayName: OpenAI.Inference + + - template: templates/steps/typespec-ci.yml + parameters: + Folder: specification/translation/Azure.AI.TextTranslation + DisplayName: AI.TextTranslation From 37843a4a053917459220f39492563d9b726c0f9c Mon Sep 17 00:00:00 2001 From: Mahsa Sadi Date: Fri, 12 May 2023 15:01:02 -0700 Subject: [PATCH 68/79] Adding type and pool to the definitions --- .../2023-03-01-preview/definitions.json | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json index 14a9013c9c40..70b45a7827f7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json @@ -1933,6 +1933,24 @@ "circuitBreaker": { "$ref": "#/definitions/BackendCircuitBreaker", "description": "Backend Circuit Breaker Configuration" + }, + "pool": { + "allOf": [ + { + "$ref": "#/definitions/BackendPool.json" + }, + { + "description": "Backend Pool Properties" + } + ] + }, + "type": { + "type": "string", + "enum": [ + "single", + "pool" + ], + "description": "Type of the backend. A backend can be either Single or Pool." } }, "description": "Backend entity base Parameter set." From e86183e1978ac7296eac7a0c9a7cd1fcb44f9b37 Mon Sep 17 00:00:00 2001 From: Mahsa Sadi Date: Fri, 12 May 2023 15:09:35 -0700 Subject: [PATCH 69/79] modifying backend contract to support type and pool --- .../2023-03-01-preview/definitions.json | 28 ++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json index 70b45a7827f7..ab9a9087412d 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json @@ -1950,7 +1950,8 @@ "single", "pool" ], - "description": "Type of the backend. A backend can be either Single or Pool." + "description": "Type of the backend. A backend can be either Single or Pool.", + "x-apim-code-nillable": true } }, "description": "Backend entity base Parameter set." @@ -2352,6 +2353,31 @@ } } }, + "BackendPool": { + "type": "object", + "description": "Backend pool information", + "properties": { + "services": { + "type": "array", + "description": "The list of backend entities belonging to a pool.", + "items": { + "$ref": "#/definitions/BackendPoolItem.json" + }, + "minItems": 2 + } + } + }, + "BackendPoolItem": { + "type": "object", + "description": "Pool service information", + "properties": { + "id": { + "type": "string", + "description": "The unique id of the backend entity. The ID should refer to an already existing backend entity.", + "x-apim-code-resourceId": "/backends/{backendId}" + } + } + }, "BearerTokenSendingMethodsContract": { "type": "string", "description": "Form of an authorization grant, which the client uses to request the access token.", From 4bef69fc5dba100f9ee4dbe8f97e08314c5ac01e Mon Sep 17 00:00:00 2001 From: Mahsa Sadi Date: Fri, 12 May 2023 15:21:04 -0700 Subject: [PATCH 70/79] fixing the errors --- .../preview/2023-03-01-preview/definitions.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json index ab9a9087412d..3942e721bd09 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json @@ -1937,7 +1937,7 @@ "pool": { "allOf": [ { - "$ref": "#/definitions/BackendPool.json" + "$ref": "#/definitions/BackendPool" }, { "description": "Backend Pool Properties" @@ -2361,7 +2361,7 @@ "type": "array", "description": "The list of backend entities belonging to a pool.", "items": { - "$ref": "#/definitions/BackendPoolItem.json" + "$ref": "#/definitions/BackendPoolItem" }, "minItems": 2 } From 3ac733b1b1c63969fbed0c7ffe60ff5cccc708c7 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Fri, 12 May 2023 15:46:27 -0700 Subject: [PATCH 71/79] [TypeSpec CI] Remove HealthInsights folders not emitting autorest (#23964) --- eng/pipelines/typespec-ci.yml | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/eng/pipelines/typespec-ci.yml b/eng/pipelines/typespec-ci.yml index 244e8c42b465..fcb73a56a575 100644 --- a/eng/pipelines/typespec-ci.yml +++ b/eng/pipelines/typespec-ci.yml @@ -23,21 +23,11 @@ jobs: Folder: specification/cognitiveservices/ContentSafety DisplayName: ContentSafety - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype - DisplayName: healthinsights.oncophenotype - - template: templates/steps/typespec-ci.yml parameters: Folder: specification/cognitiveservices/HealthInsights/healthinsights.openapi DisplayName: healthinsights.openapi - - template: templates/steps/typespec-ci.yml - parameters: - Folder: specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher - DisplayName: healthinsights.trialmatcher - - template: templates/steps/typespec-ci.yml parameters: Folder: specification/cognitiveservices/OpenAI.Authoring From 36b66d9ef1d9b78156982da46385b5969f675464 Mon Sep 17 00:00:00 2001 From: Mark Cowlishaw Date: Fri, 12 May 2023 18:34:01 -0700 Subject: [PATCH 72/79] [TypeSpec-Clean]: Content-safety changes (#23965) * Content-safety changes * Include swagger * Responding to review comments --- .../ContentSafety/routes.tsp | 22 ++++++++++--------- .../ContentSafety/tspconfig.yaml | 5 +++-- .../2023-04-30-preview/contentsafety.json | 4 ++-- 3 files changed, 17 insertions(+), 14 deletions(-) diff --git a/specification/cognitiveservices/ContentSafety/routes.tsp b/specification/cognitiveservices/ContentSafety/routes.tsp index a8736c4483e4..ed7eefc5212e 100644 --- a/specification/cognitiveservices/ContentSafety/routes.tsp +++ b/specification/cognitiveservices/ContentSafety/routes.tsp @@ -1,5 +1,4 @@ import "@azure-tools/typespec-azure-core"; -import "@azure-tools/typespec-client-generator-core"; import "@typespec/http"; import "@typespec/rest"; import "./models.tsp"; @@ -9,7 +8,6 @@ using TypeSpec.Rest; using TypeSpec.Versioning; using Azure.Core; using Azure.Core.Traits; -using Azure.ClientGenerator.Core; namespace ContentSafety; @@ -43,26 +41,30 @@ interface ImageOperations { >; } +interface BlockOps + extends Azure.Core.ResourceOperations {} interface TextBlocklists { @summary("Get Text Blocklist By blocklistName") @doc("Returns text blocklist details.") - getTextBlocklist is Azure.Core.ResourceRead; + getTextBlocklist is BlockOps.ResourceRead; @summary("Create Or Update Text Blocklist") @doc("Updates a text blocklist, if blocklistName does not exist, create a new blocklist.") - createOrUpdateTextBlocklist is Azure.Core.ResourceCreateOrUpdate; + createOrUpdateTextBlocklist is BlockOps.ResourceCreateOrUpdate; @summary("Delete Text Blocklist By blocklistName") @doc("Deletes a text blocklist.") - deleteTextBlocklist is Azure.Core.ResourceDelete; + deleteTextBlocklist is BlockOps.ResourceDelete; @summary("Get All Text Blocklists") @doc("Get all text blocklists details.") - listTextBlocklists is Azure.Core.ResourceList; + listTextBlocklists is BlockOps.ResourceList; @summary("Add BlockItems To Text Blocklist") @doc("Add blockItems to a text blocklist. You can add at most 100 BlockItems in one request.") - addBlockItems is ResourceAction< + addBlockItems is BlockOps.ResourceAction< TextBlocklist, AddBlockItemsOptions, AddBlockItemsResult @@ -70,7 +72,7 @@ interface TextBlocklists { @summary("Remove BlockItems From Text Blocklist") @doc("Remove blockItems from a text blocklist. You can remove at most 100 BlockItems in one request.") - removeBlockItems is ResourceAction< + removeBlockItems is BlockOps.ResourceAction< TextBlocklist, RemoveBlockItemsOptions, NoContentResponse @@ -78,11 +80,11 @@ interface TextBlocklists { @summary("Get BlockItem By blocklistName And blockItemId") @doc("Get blockItem By blockItemId from a text blocklist.") - getTextBlocklistItem is Azure.Core.ResourceRead; + getTextBlocklistItem is BlockOps.ResourceRead; @summary("Get All BlockItems By blocklistName") @doc("Get all blockItems in a text blocklist") - listTextBlocklistItems is Azure.Core.ResourceList< + listTextBlocklistItems is BlockOps.ResourceList< TextBlockItem, ListQueryParametersTrait >; diff --git a/specification/cognitiveservices/ContentSafety/tspconfig.yaml b/specification/cognitiveservices/ContentSafety/tspconfig.yaml index 976e4bb86aa4..adf734570bd8 100644 --- a/specification/cognitiveservices/ContentSafety/tspconfig.yaml +++ b/specification/cognitiveservices/ContentSafety/tspconfig.yaml @@ -13,8 +13,9 @@ emit: - "@azure-tools/typespec-autorest" options: "@azure-tools/typespec-autorest": - output-file: "contentsafety.json" - azure-resource-provider-folder: ../../../../data-plane + emitter-output-dir: "{project-root}/../" + output-file: "{azure-resource-provider-folder}/{service-name}/{version-status}/{version}/contentsafety.json" + azure-resource-provider-folder: "data-plane" examples-directory: ./examples "@azure-tools/typespec-python": package-name: "azure-ai-contentsafety" diff --git a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json index c365ee78d707..cfddf992ac58 100644 --- a/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json +++ b/specification/cognitiveservices/data-plane/ContentSafety/preview/2023-04-30-preview/contentsafety.json @@ -121,7 +121,7 @@ "type": "string", "format": "uri", "description": "The link to the next page of items", - "x-typespec-name": "Rest.ResourceLocation" + "x-typespec-name": "TypeSpec.Rest.ResourceLocation" } }, "description": "Paged collection of TextBlocklist items", @@ -453,7 +453,7 @@ "type": "string", "format": "uri", "description": "The link to the next page of items", - "x-typespec-name": "Rest.ResourceLocation" + "x-typespec-name": "TypeSpec.Rest.ResourceLocation" } }, "description": "Paged collection of TextBlockItem items", From 2bfcaadeda53700ea5ed15cc3eabf7c332c0dfaa Mon Sep 17 00:00:00 2001 From: Mark Cowlishaw Date: Fri, 12 May 2023 18:34:42 -0700 Subject: [PATCH 73/79] [TypeSpec-Clean]: Updating HealthInsights (#23966) * Updating HealthInsights * Apply suggestions from code review Respondign to review comments Co-authored-by: Mike Harder * Fixing bad service name in config --------- Co-authored-by: Mike Harder --- .../model.common.response.tsp | 2 +- .../healthinsights.common/primitives.tsp | 22 +++++++++---------- .../route.oncophenotype.tsp | 13 ++++++++--- .../healthinsights.openapi/tspconfig.yaml | 4 +++- .../route.trialmatcher.tsp | 14 ++++++++---- 5 files changed, 35 insertions(+), 20 deletions(-) diff --git a/specification/cognitiveservices/HealthInsights/healthinsights.common/model.common.response.tsp b/specification/cognitiveservices/HealthInsights/healthinsights.common/model.common.response.tsp index 96f222532591..64648b8e0614 100644 --- a/specification/cognitiveservices/HealthInsights/healthinsights.common/model.common.response.tsp +++ b/specification/cognitiveservices/HealthInsights/healthinsights.common/model.common.response.tsp @@ -5,6 +5,7 @@ using TypeSpec.Rest; namespace AzureHealthInsights; alias Response = { + #suppress "@azure-tools/typespec-azure-core/no-format" "This is an old spec" @doc("A processing job identifier.") @visibility("read") @key @@ -32,7 +33,6 @@ alias Response = { errors?: Azure.Core.Foundations.Error[]; }; - @doc("An inference made by the model regarding a patient.") model Inference { @doc("The value of the inference, as relevant for the given inference type.") diff --git a/specification/cognitiveservices/HealthInsights/healthinsights.common/primitives.tsp b/specification/cognitiveservices/HealthInsights/healthinsights.common/primitives.tsp index a377638982d9..c1fabf7a1040 100644 --- a/specification/cognitiveservices/HealthInsights/healthinsights.common/primitives.tsp +++ b/specification/cognitiveservices/HealthInsights/healthinsights.common/primitives.tsp @@ -2,16 +2,16 @@ using Azure.Core; using TypeSpec.Http; namespace AzureHealthInsights; +#suppress "@azure-tools/typespec-azure-core/long-running-polling-operation-required" "This is a template" @doc("Long running RPC operation template") op LongRunningRpcOperation< - TParams extends object, - TResponse extends object, - Traits extends object = {} - > is RpcOperation< - TParams & Traits, - Foundations.AcceptedResponse | TResponse, - Traits - >; + TParams, + TResponse +> is Azure.Core.Foundations.Operation< + TParams & RepeatabilityRequestHeaders, + (Foundations.AcceptedResponse & + RepeatabilityResponseHeaders) | TResponse, + RepeatabilityRequestHeaders & RepeatabilityResponseHeaders, + Azure.Core.Foundations.ErrorResponse +>; diff --git a/specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype/route.oncophenotype.tsp b/specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype/route.oncophenotype.tsp index b4ac1b2b311b..deb8469dd91a 100644 --- a/specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype/route.oncophenotype.tsp +++ b/specification/cognitiveservices/HealthInsights/healthinsights.oncophenotype/route.oncophenotype.tsp @@ -17,14 +17,21 @@ interface OncoPhenotype { @summary("Get Onco Phenotype job details") @tag("OncoPhenotype") @doc("Gets the status and details of the Onco Phenotype job.") - @example("./examples/SuccessfulOncoPhenotypeResponse.json", "SuccessfulOncoPhenotypeGetAnalyzeStatus") + @example( + "./examples/SuccessfulOncoPhenotypeResponse.json", + "SuccessfulOncoPhenotypeGetAnalyzeStatus" + ) GetJob is Azure.Core.ResourceRead; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" @summary("Create Onco Phenotype job") @tag("OncoPhenotype") @doc("Creates an Onco Phenotype job with the given request body.") @pollingOperation(OncoPhenotype.GetJob) @route("/oncophenotype/jobs") - @example("./examples/SuccessfulOncoPhenotypeRequest.json", "SuccessfulOncoPhenotypeAnalyzeRequest") - CreateJob is LongRunningRpcOperation; + @example( + "./examples/SuccessfulOncoPhenotypeRequest.json", + "SuccessfulOncoPhenotypeAnalyzeRequest" + ) + CreateJob is LongRunningRpcOperation; } diff --git a/specification/cognitiveservices/HealthInsights/healthinsights.openapi/tspconfig.yaml b/specification/cognitiveservices/HealthInsights/healthinsights.openapi/tspconfig.yaml index e2d33c67e55f..b7a1eafdba74 100644 --- a/specification/cognitiveservices/HealthInsights/healthinsights.openapi/tspconfig.yaml +++ b/specification/cognitiveservices/HealthInsights/healthinsights.openapi/tspconfig.yaml @@ -6,5 +6,7 @@ emit: [ options: "@azure-tools/typespec-autorest": - output-file: "openapi.json" + azure-resource-provider-folder: "./data-plane" + emitter-output-dir: "{project-root}/../.." + output-file: "{azure-resource-provider-folder}/HealthInsights/{version-status}/{version}/openapi.json" examples-directory: "./examples" diff --git a/specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher/route.trialmatcher.tsp b/specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher/route.trialmatcher.tsp index 337120b151ba..413569f2327e 100644 --- a/specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher/route.trialmatcher.tsp +++ b/specification/cognitiveservices/HealthInsights/healthinsights.trialmatcher/route.trialmatcher.tsp @@ -17,15 +17,21 @@ interface TrialMatcher { @summary("Get Trial Matcher job details") @tag("TrialMatcher") @doc("Gets the status and details of the Trial Matcher job.") - @example("./examples/SuccessfulTrialMatcherResponse.json", "SuccessfulTrialMatcherGetAnalyzeStatus") + @example( + "./examples/SuccessfulTrialMatcherResponse.json", + "SuccessfulTrialMatcherGetAnalyzeStatus" + ) GetJob is Azure.Core.ResourceRead; + #suppress "@azure-tools/typespec-azure-core/use-standard-operations" "There is no long-running RPC template in Azure.Core" @summary("Create Trial Matcher job") @tag("TrialMatcher") @doc("Creates a Trial Matcher job with the given request body.") @pollingOperation(TrialMatcher.GetJob) @route("/trialmatcher/jobs") - @example("./examples/SuccessfulTrialMatcherRequest.json", "SuccessfulTrialMatcherAnalyzeRequest") - CreateJob is LongRunningRpcOperation; + @example( + "./examples/SuccessfulTrialMatcherRequest.json", + "SuccessfulTrialMatcherAnalyzeRequest" + ) + CreateJob is LongRunningRpcOperation; } - From 4e90cf03db9aa9930caf1b5ab38fea18f4627a31 Mon Sep 17 00:00:00 2001 From: Mark Cowlishaw Date: Fri, 12 May 2023 18:35:22 -0700 Subject: [PATCH 74/79] [TypeSpec-Clean] Update for Azure.AI.TextTranslation (#23971) * Update for Azure.AI.TextTranslation * Update tspconfig Co-authored-by: Mike Harder --------- Co-authored-by: Mike Harder --- .../translation/Azure.AI.TextTranslation/tspconfig.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml index d203f332194b..b02fa0e8a44c 100644 --- a/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml +++ b/specification/translation/Azure.AI.TextTranslation/tspconfig.yaml @@ -13,10 +13,10 @@ emit: - "@azure-tools/typespec-autorest" options: "@azure-tools/typespec-autorest": - azure-resource-provider-folder: "../data-plane/Azure.AI.TextTranslation" + azure-resource-provider-folder: "./data-plane" emitter-output-dir: "{project-root}/.." examples-directory: "./examples" - output-file: openapi.json + output-file: "{azure-resource-provider-folder}/Azure.AI.TextTranslation/stable/v3.0/openapi.json" "@azure-tools/typespec-csharp": clear-output-folder: true emitter-output-dir: "{csharp-sdk-folder}/sdk/{service-directory-name}/{namespace}/src" From 18b397a02e5c7b856f61b6d7fb66a69c9c56c8ce Mon Sep 17 00:00:00 2001 From: Mark Cowlishaw Date: Fri, 12 May 2023 19:04:13 -0700 Subject: [PATCH 75/79] Updates for OpenAi.Inference (#23970) --- .../models/chat.completions.tsp | 8 ++--- .../models/completions.create.tsp | 10 +++--- .../OpenAI.Inference/routes.tsp | 33 +++++++++++-------- .../OpenAI.Inference/tspconfig.yaml | 4 +-- 4 files changed, 31 insertions(+), 24 deletions(-) diff --git a/specification/cognitiveservices/OpenAI.Inference/models/chat.completions.tsp b/specification/cognitiveservices/OpenAI.Inference/models/chat.completions.tsp index 9b0f7d94c7cd..88a9b3fcdd74 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/chat.completions.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/chat.completions.tsp @@ -139,8 +139,8 @@ model ChatCompletionsOptions { """) @projectedName("json", "model") @projectedName("csharp", "InternalNonAzureModelName") - "model"?: string; -}; + `model`?: string; +} @doc(""" The representation of a single prompt completion as part of an overall chat completions request. @@ -158,7 +158,7 @@ model ChatChoice { @doc("The reason that this chat completions choice completed its generated.") @projectedName("json", "finish_reason") - finishReason: CompletionsFinishReason | null; + finishReason?: CompletionsFinishReason; @doc("The delta message content for a streaming response.") @projectedName("json", "delta") @@ -197,4 +197,4 @@ model ChatCompletions { """) @projectedName("json", "usage") usage: CompletionsUsage; -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/OpenAI.Inference/models/completions.create.tsp b/specification/cognitiveservices/OpenAI.Inference/models/completions.create.tsp index e88329c9e2a3..30c51baf842f 100644 --- a/specification/cognitiveservices/OpenAI.Inference/models/completions.create.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/models/completions.create.tsp @@ -136,8 +136,8 @@ model CompletionsOptions { """) @projectedName("json", "model") @projectedName("csharp", "InternalNonAzureModelName") - "model"?: string; -}; + `model`?: string; +} @doc(""" Representation of the response data from a completions request. @@ -189,11 +189,11 @@ model Choice { @doc("The log probabilities model for tokens associated with this completions choice.") @projectedName("json", "logprobs") @projectedName("csharp", "LogProbabilityModel") - logprobs: CompletionsLogProbabilityModel | null; + logprobs?: CompletionsLogProbabilityModel; @doc("Reason for finishing") @projectedName("json", "finish_reason") - finishReason: CompletionsFinishReason | null; + finishReason?: CompletionsFinishReason; } alias NullableFloat = float32 | null; @@ -220,4 +220,4 @@ model CompletionsLogProbabilityModel { @projectedName("json", "text_offset") @projectedName("csharp", "TextOffsets") textOffset: int32[]; -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/OpenAI.Inference/routes.tsp b/specification/cognitiveservices/OpenAI.Inference/routes.tsp index f5109b082876..5c2cb74af0e3 100644 --- a/specification/cognitiveservices/OpenAI.Inference/routes.tsp +++ b/specification/cognitiveservices/OpenAI.Inference/routes.tsp @@ -1,7 +1,7 @@ import "@azure-tools/typespec-azure-core"; import "@typespec/rest"; import "@typespec/http"; -import "@azure-tools/typespec-client-generator-core"; +//import "@azure-tools/typespec-client-generator-core"; import "./models/completions.create.tsp"; import "./models/chat.completions.tsp"; @@ -10,16 +10,18 @@ import "./models/embeddings.create.tsp"; using TypeSpec.Rest; using TypeSpec.Http; using Azure.Core; -using Azure.ClientGenerator.Core; +//using Azure.ClientGenerator.Core; namespace Azure.OpenAI; @doc("Return the embeddings for a given prompt.") @TypeSpec.Rest.actionSeparator("/") -@action("embeddings") -@convenientAPI(true) -op getEmbeddings is Azure.Core.ResourceAction; - +@action("embeddings") //@convenientAPI(true) +op getEmbeddings is Azure.Core.ResourceAction< + Deployment, + EmbeddingsOptions, + Embeddings +>; @doc(""" Gets completions for the provided input prompts. @@ -27,10 +29,12 @@ Completions support a wide variety of tasks and generate text that continues fro provided prompt data. """) @TypeSpec.Rest.actionSeparator("/") -@action("completions") -@convenientAPI(true) -op getCompletions is Azure.Core.ResourceAction; - +@action("completions") //@convenientAPI(true) +op getCompletions is Azure.Core.ResourceAction< + Deployment, + CompletionsOptions, + Completions +>; @doc(""" Gets chat completions for the provided chat messages. @@ -38,6 +42,9 @@ Completions support a wide variety of tasks and generate text that continues fro provided prompt data. """) @TypeSpec.Rest.actionSeparator("/") -@action("chat/completions") -@convenientAPI(true) -op getChatCompletions is Azure.Core.ResourceAction; +@action("chat/completions") //@convenientAPI(true) +op getChatCompletions is Azure.Core.ResourceAction< + Deployment, + ChatCompletionsOptions, + ChatCompletions +>; diff --git a/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml b/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml index 9300c257a2d1..241fa1576e6f 100644 --- a/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml +++ b/specification/cognitiveservices/OpenAI.Inference/tspconfig.yaml @@ -1,6 +1,6 @@ emit: - - "@azure-tools/typespec-autorest" - - "@azure-tools/cadl-apiview" +# - "@azure-tools/typespec-autorest" +# - "@azure-tools/cadl-apiview" options: # Uncomment this line and add "@azure-tools/cadl-python" to your package.json to generate Python code # "@azure-tools/cadl-python": From 9f1fc4ec1d4246f5f1f594541fe76fdd8a0712a8 Mon Sep 17 00:00:00 2001 From: thomasp98296 Date: Sun, 14 May 2023 22:54:31 -0700 Subject: [PATCH 76/79] Add new test notification APIs for Tenant Action Groups (#23714) * Initial changes/baseline * New changes for 2023-05-01-preview * Make the new api default * Fix build * Add regex name validation * name validation * Regex * Change type. * Fix typo * Change to v2 --------- Co-authored-by: Thomas Pham --- .../createOrUpdateTenantActionGroup.json | 201 ++++ .../examples/deleteTenantActionGroup.json | 12 + .../examples/getTenantActionGroup.json | 75 ++ ...tionsAtTenantActionGroupResourceLevel.json | 73 ++ .../examples/listTenantActionGroups.json | 78 ++ .../examples/patchTenantActionGroup.json | 87 ++ ...tionsAtTenantActionGroupResourceLevel.json | 133 +++ .../tenantActionGroups_API.json | 862 ++++++++++++++++++ .../monitor/resource-manager/readme.md | 10 +- 9 files changed, 1530 insertions(+), 1 deletion(-) create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/createOrUpdateTenantActionGroup.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/deleteTenantActionGroup.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/getTenantActionGroup.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/getTestNotificationsAtTenantActionGroupResourceLevel.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/listTenantActionGroups.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/patchTenantActionGroup.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/postTestNotificationsAtTenantActionGroupResourceLevel.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/createOrUpdateTenantActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/createOrUpdateTenantActionGroup.json new file mode 100644 index 000000000000..42bedcb87370 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/createOrUpdateTenantActionGroup.json @@ -0,0 +1,201 @@ +{ + "parameters": { + "managementGroupId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "tenantActionGroupName": "testTenantActionGroup", + "api-version": "2023-05-01-preview", + "x-ms-client-tenant-id": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "actionGroup": { + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "useCommonAlertSchema": false + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "useCommonAlertSchema": true + } + ], + "smsReceivers": [ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "2062022299" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321" + } + ], + "webhookReceivers": [ + { + "name": "Sample webhook 1", + "serviceUri": "http://www.example.com/webhook1", + "useCommonAlertSchema": true + }, + { + "name": "Sample webhook 2", + "serviceUri": "http://www.example.com/webhook2", + "useCommonAlertSchema": true, + "useAadAuth": true, + "objectId": "d3bb868c-fe44-452c-aa26-769a6538c808", + "identifierUri": "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a", + "tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84" + } + ], + "azureAppPushReceivers": [ + { + "name": "Sample azureAppPush", + "emailAddress": "johndoe@email.com" + } + ], + "voiceReceivers": [ + { + "name": "Sample voice", + "countryCode": "1", + "phoneNumber": "2062022299" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/providers/Microsoft.Management/managementGroups/72f988bf-86f1-41af-91ab-2d7cd011db47/providers/Microsoft.Insights/tenantActionGroups/testTenantActionGroup", + "type": "Microsoft.Insights/TenantActionGroups", + "name": "testTenantActionGroup", + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled", + "useCommonAlertSchema": false + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "status": "Enabled", + "useCommonAlertSchema": true + } + ], + "smsReceivers": [ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "2062022299", + "status": "Enabled" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers": [ + { + "name": "Sample webhook 1", + "serviceUri": "http://www.example.com/webhook1", + "useCommonAlertSchema": true + }, + { + "name": "Sample webhook 2", + "serviceUri": "http://www.example.com/webhook2", + "useCommonAlertSchema": true, + "useAadAuth": true, + "objectId": "d3bb868c-fe44-452c-aa26-769a6538c808", + "identifierUri": "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a", + "tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84" + } + ], + "voiceReceivers": [ + { + "name": "Sample voice", + "countryCode": "1", + "phoneNumber": "2062022299" + } + ] + } + } + }, + "201": { + "headers": {}, + "body": { + "id": "/providers/Microsoft.Management/managementGroups/72f988bf-86f1-41af-91ab-2d7cd011db47/providers/Microsoft.Insights/tenantActionGroups/testTenantActionGroup", + "type": "Microsoft.Insights/TenantActionGroups", + "name": "testTenantActionGroup", + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled", + "useCommonAlertSchema": false + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "status": "Enabled", + "useCommonAlertSchema": true + } + ], + "smsReceivers": [ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "2062022299", + "status": "Enabled" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers": [ + { + "name": "Sample webhook 1", + "serviceUri": "http://www.example.com/webhook1", + "useCommonAlertSchema": true + }, + { + "name": "Sample webhook 2", + "serviceUri": "http://www.example.com/webhook2", + "useCommonAlertSchema": true, + "useAadAuth": true, + "objectId": "d3bb868c-fe44-452c-aa26-769a6538c808", + "identifierUri": "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a", + "tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84" + } + ], + "voiceReceivers": [ + { + "name": "Sample voice", + "countryCode": "1", + "phoneNumber": "2062022299" + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/deleteTenantActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/deleteTenantActionGroup.json new file mode 100644 index 000000000000..3de00a2123cd --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/deleteTenantActionGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "managementGroupId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "tenantActionGroupName": "testTenantActionGroup", + "api-version": "2023-05-01-preview", + "x-ms-client-tenant-id": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/getTenantActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/getTenantActionGroup.json new file mode 100644 index 000000000000..8f34caadf97b --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/getTenantActionGroup.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "managementGroupId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "tenantActionGroupName": "testTenantActionGroup", + "api-version": "2023-05-01-preview", + "x-ms-client-tenant-id": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/providers/Microsoft.Management/managementGroups/72f988bf-86f1-41af-91ab-2d7cd011db47/providers/Microsoft.Insights/tenantActionGroups/testTenantActionGroup", + "type": "Microsoft.Insights/TenantActionGroups", + "name": "testTenantActionGroup", + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled", + "useCommonAlertSchema": false + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "status": "Enabled", + "useCommonAlertSchema": true + } + ], + "smsReceivers": [ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "2062022299", + "status": "Enabled" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers": [ + { + "name": "Sample webhook 1", + "serviceUri": "http://www.example.com/webhook1", + "useCommonAlertSchema": true + }, + { + "name": "Sample webhook 2", + "serviceUri": "http://www.example.com/webhook2", + "useCommonAlertSchema": true, + "useAadAuth": true, + "objectId": "d3bb868c-fe44-452c-aa26-769a6538c808", + "identifierUri": "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a", + "tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84" + } + ], + "voiceReceivers": [ + { + "name": "Sample voice", + "countryCode": "1", + "phoneNumber": "2062022299" + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/getTestNotificationsAtTenantActionGroupResourceLevel.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/getTestNotificationsAtTenantActionGroupResourceLevel.json new file mode 100644 index 000000000000..2ab8f678d25e --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/getTestNotificationsAtTenantActionGroupResourceLevel.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "managementGroupId": "11111111-1111-1111-1111-111111111111", + "tenantActionGroupName": "testTenantActionGroup", + "x-ms-client-tenant-id": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "notificationId": "11000222191287", + "api-version": "2023-05-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "context": { + "notificationSource": "Microsoft.Insights/TestNotification", + "contextType": "Microsoft.Insights/ServiceHealth" + }, + "state": "Completed", + "completedTime": "0001-01-01T00:00:00+00:00", + "createdTime": "2021-09-21T04:52:29.5091168+00:00", + "actionDetails": [ + { + "mechanismType": "AzureAppPush", + "name": "AzureAppPush-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:42.8620629+00:00", + "message": null + }, + { + "mechanismType": "Email", + "name": "Email-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:40.7480368+00:00", + "message": null + }, + { + "mechanismType": "Webhook", + "name": "Webhook-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:42.0723479+00:00", + "message": null + }, + { + "mechanismType": "SecureWebhook", + "name": "SecureWebhook-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:42.0723479+00:00", + "message": null + }, + { + "mechanismType": "Sms", + "name": "Sms-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:41.353015+00:00", + "message": null + }, + { + "mechanismType": "Voice", + "name": "Voice-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:41.6330734+00:00", + "message": null + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/listTenantActionGroups.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/listTenantActionGroups.json new file mode 100644 index 000000000000..5fd2c6723c4a --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/listTenantActionGroups.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "managementGroupId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "api-version": "2023-05-01-preview", + "x-ms-client-tenant-id": "72f988bf-86f1-41af-91ab-2d7cd011db47" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/providers/Microsoft.Management/managementGroups/72f988bf-86f1-41af-91ab-2d7cd011db47/providers/Microsoft.Insights/tenantActionGroups/testTenantActionGroup", + "type": "Microsoft.Insights/TenantActionGroups", + "name": "testTenantActionGroup", + "location": "Global", + "tags": {}, + "properties": { + "groupShortName": "sample", + "enabled": true, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled", + "useCommonAlertSchema": false + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "status": "Enabled", + "useCommonAlertSchema": true + } + ], + "smsReceivers": [ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "2062022299", + "status": "Enabled" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers": [ + { + "name": "Sample webhook 1", + "serviceUri": "http://www.example.com/webhook1", + "useCommonAlertSchema": true + }, + { + "name": "Sample webhook 2", + "serviceUri": "http://www.example.com/webhook2", + "useCommonAlertSchema": true, + "useAadAuth": true, + "objectId": "d3bb868c-fe44-452c-aa26-769a6538c808", + "identifierUri": "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a", + "tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84" + } + ], + "voiceReceivers": [ + { + "name": "Sample voice", + "countryCode": "1", + "phoneNumber": "2062022299" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/patchTenantActionGroup.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/patchTenantActionGroup.json new file mode 100644 index 000000000000..aaf89ba42b8c --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/patchTenantActionGroup.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "managementGroupId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "tenantActionGroupName": "testTenantActionGroup", + "api-version": "2023-05-01-preview", + "x-ms-client-tenant-id": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "tenantActionGroupPatch": { + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "enabled": false + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/providers/Microsoft.Management/managementGroups/72f988bf-86f1-41af-91ab-2d7cd011db47/providers/Microsoft.Insights/tenantActionGroups/testTenantActionGroup", + "type": "Microsoft.Insights/TenantActionGroups", + "name": "testTenantActionGroup", + "location": "Global", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "groupShortName": "sample", + "enabled": false, + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "status": "Enabled", + "useCommonAlertSchema": false + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "status": "Enabled", + "useCommonAlertSchema": true + } + ], + "smsReceivers": [ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "2062022299", + "status": "Enabled" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321", + "status": "Enabled" + } + ], + "webhookReceivers": [ + { + "name": "Sample webhook 1", + "serviceUri": "http://www.example.com/webhook1", + "useCommonAlertSchema": true + }, + { + "name": "Sample webhook 2", + "serviceUri": "http://www.example.com/webhook2", + "useCommonAlertSchema": true, + "useAadAuth": true, + "objectId": "d3bb868c-fe44-452c-aa26-769a6538c808", + "identifierUri": "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a", + "tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84" + } + ], + "voiceReceivers": [ + { + "name": "Sample voice", + "countryCode": "1", + "phoneNumber": "2062022299" + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/postTestNotificationsAtTenantActionGroupResourceLevel.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/postTestNotificationsAtTenantActionGroupResourceLevel.json new file mode 100644 index 000000000000..34e82bc7e202 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/examples/postTestNotificationsAtTenantActionGroupResourceLevel.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "managementGroupId": "11111111-1111-1111-1111-111111111111", + "tenantActionGroupName": "testTenantActionGroup", + "x-ms-client-tenant-id": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "api-version": "2023-05-01-preview", + "notificationRequest": { + "alertType": "servicehealth", + "emailReceivers": [ + { + "name": "John Doe's email", + "emailAddress": "johndoe@email.com", + "useCommonAlertSchema": false + }, + { + "name": "Jane Smith's email", + "emailAddress": "janesmith@email.com", + "useCommonAlertSchema": true + } + ], + "smsReceivers": [ + { + "name": "John Doe's mobile", + "countryCode": "1", + "phoneNumber": "1234567890" + }, + { + "name": "Jane Smith's mobile", + "countryCode": "1", + "phoneNumber": "0987654321" + } + ], + "webhookReceivers": [ + { + "name": "Sample webhook 1", + "serviceUri": "http://www.example.com/webhook1", + "useCommonAlertSchema": true + }, + { + "name": "Sample webhook 2", + "serviceUri": "http://www.example.com/webhook2", + "useCommonAlertSchema": true, + "useAadAuth": true, + "objectId": "d3bb868c-fe44-452c-aa26-769a6538c808", + "identifierUri": "http://someidentifier/d7811ba3-7996-4a93-99b6-6b2f3f355f8a", + "tenantId": "68a4459a-ccb8-493c-b9da-dd30457d1b84" + } + ], + "azureAppPushReceivers": [ + { + "name": "Sample azureAppPush", + "emailAddress": "johndoe@email.com" + } + ], + "voiceReceivers": [ + { + "name": "Sample voice", + "countryCode": "1", + "phoneNumber": "1234567890" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/providers/microsoft.management/managementGroups/11111111-1111-1111-1111-111111111111/providers/microsoft.insights/tenantActionGroups/testTenantActionGroup/notificationStatus/11001810058463?api-version=2023-05-01-preview" + } + }, + "200": { + "headers": {}, + "body": { + "context": { + "notificationSource": "Microsoft.Insights/TestNotification", + "contextType": "Microsoft.Insights/ServiceHealth" + }, + "state": "Completed", + "completedTime": "0001-01-01T00:00:00+00:00", + "createdTime": "2021-09-21T04:52:29.5091168+00:00", + "actionDetails": [ + { + "mechanismType": "AzureAppPush", + "name": "AzureAppPush-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:42.8620629+00:00", + "message": null + }, + { + "mechanismType": "Email", + "name": "Email-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:40.7480368+00:00", + "message": null + }, + { + "mechanismType": "Webhook", + "name": "Webhook-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:42.0723479+00:00", + "message": null + }, + { + "mechanismType": "SecureWebhook", + "name": "SecureWebhook-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:42.0723479+00:00", + "message": null + }, + { + "mechanismType": "Sms", + "name": "Sms-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:41.353015+00:00", + "message": null + }, + { + "mechanismType": "Voice", + "name": "Voice-name", + "status": "Completed", + "subState": "Default", + "sendTime": "2021-09-21T04:52:41.6330734+00:00", + "message": null + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json new file mode 100644 index 000000000000..95ce3518660d --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json @@ -0,0 +1,862 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Tenant Action Groups API", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2023-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": { + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}": { + "put": { + "description": "Create a new tenant action group or update an existing one.", + "operationId": "TenantActionGroups_CreateOrUpdate", + "x-ms-examples": { + "Create or update a tenant action group": { + "$ref": "./examples/createOrUpdateTenantActionGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/TenantIdParameter" + }, + { + "name": "actionGroup", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TenantActionGroupResource" + }, + "description": "The tenant action group to create or use for the update." + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "An existing tenant action group was successfully updated.", + "schema": { + "$ref": "#/definitions/TenantActionGroupResource" + } + }, + "201": { + "description": "A new tenant action group was successfully created.", + "schema": { + "$ref": "#/definitions/TenantActionGroupResource" + } + }, + "default": { + "description": "An error occurred and the tenant action group could not be created or updated.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "description": "Get a tenant action group.", + "operationId": "TenantActionGroups_Get", + "x-ms-examples": { + "Get an action group": { + "$ref": "./examples/getTenantActionGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/TenantIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/TenantActionGroupResource" + } + }, + "default": { + "description": "An error occurred and the tenant action group could not be retrieved. 404: The tenant action group does not exist.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "description": "Delete a tenant action group.", + "operationId": "TenantActionGroups_Delete", + "x-ms-examples": { + "Delete a tenant action group": { + "$ref": "./examples/deleteTenantActionGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/TenantIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The tenant action group was successfully deleted." + }, + "204": { + "description": "The tenant action group does not exist. It may have already been deleted." + }, + "default": { + "description": "An error occurred and the tenant action group could not be deleted.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "description": "Updates an existing tenant action group's tags. To update other fields use the CreateOrUpdate method.", + "operationId": "TenantActionGroups_Update", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/TenantIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "tenantActionGroupPatch", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActionGroupPatchBody" + }, + "description": "Parameters supplied to the operation." + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "An existing tenant action group was successfully updated.", + "schema": { + "$ref": "#/definitions/TenantActionGroupResource" + } + } + }, + "x-ms-examples": { + "Patch a tenant action group": { + "$ref": "./examples/patchTenantActionGroup.json" + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups": { + "get": { + "description": "Get a list of all tenant action groups in a management group.", + "operationId": "TenantActionGroups_ListByManagementGroupId", + "x-ms-examples": { + "List tenant action groups at management group level": { + "$ref": "./examples/listTenantActionGroups.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/TenantIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request succeeded.", + "schema": { + "$ref": "#/definitions/TenantActionGroupList" + } + }, + "default": { + "description": "An error occurred and the list of tenant action groups could not be retrieved.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}/createNotifications": { + "post": { + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Send test notifications to a set of provided receivers", + "operationId": "CreateNotificationsAtTenantActionGroupResourceLevel", + "x-ms-examples": { + "Create notifications at tenant action group level": { + "$ref": "./examples/postTestNotificationsAtTenantActionGroupResourceLevel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/TenantIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "notificationRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TenantNotificationRequestBody" + }, + "description": "The notification request body which includes the contact details" + } + ], + "responses": { + "202": { + "description": "The notification request accepted", + "headers": { + "location": { + "type": "string", + "description": "The location header that has the polling uri." + } + } + }, + "200": { + "description": "The notification succeeded", + "schema": { + "$ref": "#/definitions/TestNotificationDetailsResponse" + } + }, + "default": { + "description": "An error occurred while sending the test notifications", + "schema": { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{managementGroupId}/providers/Microsoft.Insights/tenantActionGroups/{tenantActionGroupName}/notificationStatus/{notificationId}": { + "get": { + "description": "Get the test notifications by the notification id", + "operationId": "GetTestNotificationsAtTenantActionGroupResourceLevel", + "x-ms-examples": { + "Get notification details at tenant action group level": { + "$ref": "./examples/getTestNotificationsAtTenantActionGroupResourceLevel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/ActionGroupNameParameter" + }, + { + "$ref": "#/parameters/TenantIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NotificationIdParameter" + } + ], + "responses": { + "200": { + "description": "The notification details", + "schema": { + "$ref": "#/definitions/TestNotificationDetailsResponse" + } + }, + "default": { + "description": "An error occurred while sending the test notifications", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "AzureResource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "type": "object", + "x-ms-azure-resource": true, + "description": "An azure resource object" + }, + "TenantNotificationRequestBody": { + "description": "The request body which contain contact detail metadata", + "type": "object", + "properties": { + "alertType": { + "type": "string", + "maxLength": 30, + "description": "The value of the supported alert type. Supported alert type value is: servicehealth" + }, + "emailReceivers": { + "x-ms-identifiers": [], + "type": "array", + "items": { + "$ref": "#/definitions/EmailReceiver" + }, + "description": "The list of email receivers that are part of this action group." + }, + "smsReceivers": { + "x-ms-identifiers": [], + "type": "array", + "items": { + "$ref": "#/definitions/SmsReceiver" + }, + "description": "The list of SMS receivers that are part of this action group." + }, + "webhookReceivers": { + "x-ms-identifiers": [], + "type": "array", + "items": { + "$ref": "#/definitions/WebhookReceiver" + }, + "description": "The list of webhook receivers that are part of this action group." + }, + "azureAppPushReceivers": { + "x-ms-identifiers": [], + "type": "array", + "items": { + "$ref": "#/definitions/AzureAppPushReceiver" + }, + "description": "The list of AzureAppPush receivers that are part of this action group." + }, + "voiceReceivers": { + "x-ms-identifiers": [], + "type": "array", + "items": { + "$ref": "#/definitions/VoiceReceiver" + }, + "description": "The list of voice receivers that are part of this action group." + } + }, + "required": [ + "alertType" + ] + }, + "TestNotificationDetailsResponse": { + "description": "The details of the test notification results.", + "type": "object", + "properties": { + "context": { + "type": "object", + "$ref": "#/definitions/Context" + }, + "state": { + "type": "string", + "description": "The overall state" + }, + "completedTime": { + "type": "string", + "description": "The completed time" + }, + "createdTime": { + "type": "string", + "description": "The created time" + }, + "actionDetails": { + "x-ms-identifiers": [], + "type": "array", + "items": { + "$ref": "#/definitions/ActionDetail" + }, + "description": "The list of action detail" + } + }, + "required": [ + "state" + ] + }, + "ActionDetail": { + "description": "The action detail", + "type": "object", + "properties": { + "mechanismType": { + "type": "string", + "description": "The mechanism type" + }, + "name": { + "type": "string", + "description": "The name of the action" + }, + "status": { + "type": "string", + "description": "The status of the action" + }, + "subState": { + "type": "string", + "description": "The substatus of the action" + }, + "sendTime": { + "type": "string", + "description": "The send time" + }, + "message": { + "type": "string", + "description": "The detail of the friendly error message" + } + } + }, + "Context": { + "description": "The context info", + "type": "object", + "properties": { + "notificationSource": { + "type": "string", + "description": "The source of the notification request" + }, + "contextType": { + "type": "string", + "description": "The context id type" + } + } + }, + "TenantActionGroupResource": { + "description": "A tenant action group resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AzureResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TenantActionGroup", + "description": "The tenant action groups properties of the resource." + } + } + }, + "TenantActionGroupList": { + "description": "A list of tenant action groups.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TenantActionGroupResource" + }, + "description": "The list of tenant action groups." + }, + "nextLink": { + "type": "string", + "description": "Provides the link to retrieve the next set of elements." + } + } + }, + "TenantActionGroup": { + "description": "A tenant action group.", + "type": "object", + "properties": { + "groupShortName": { + "type": "string", + "maxLength": 12, + "description": "The short name of the action group. This will be used in SMS messages." + }, + "enabled": { + "type": "boolean", + "default": true, + "description": "Indicates whether this tenant action group is enabled. If a tenant action group is not enabled, then none of its receivers will receive communications." + }, + "emailReceivers": { + "x-ms-identifiers": [ + "emailAddress" + ], + "type": "array", + "items": { + "$ref": "#/definitions/EmailReceiver" + }, + "description": "The list of email receivers that are part of this tenant action group." + }, + "smsReceivers": { + "x-ms-identifiers": [ + "phoneNumber" + ], + "type": "array", + "items": { + "$ref": "#/definitions/SmsReceiver" + }, + "description": "The list of SMS receivers that are part of this tenant action group." + }, + "webhookReceivers": { + "x-ms-identifiers": [ + "name" + ], + "type": "array", + "items": { + "$ref": "#/definitions/WebhookReceiver" + }, + "description": "The list of webhook receivers that are part of this tenant action group." + }, + "azureAppPushReceivers": { + "x-ms-identifiers": [ + "emailAddress" + ], + "type": "array", + "items": { + "$ref": "#/definitions/AzureAppPushReceiver" + }, + "description": "The list of AzureAppPush receivers that are part of this tenant action group." + }, + "voiceReceivers": { + "x-ms-identifiers": [ + "phoneNumber" + ], + "type": "array", + "items": { + "$ref": "#/definitions/VoiceReceiver" + }, + "description": "The list of voice receivers that are part of this tenant action group." + } + }, + "required": [ + "groupShortName", + "enabled" + ] + }, + "EmailReceiver": { + "description": "An email receiver.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the email receiver. Names must be unique across all receivers within a tenant action group." + }, + "emailAddress": { + "type": "string", + "description": "The email address of this receiver." + }, + "useCommonAlertSchema": { + "type": "boolean", + "default": false, + "description": "Indicates whether to use common alert schema." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ReceiverStatus", + "description": "The receiver status of the e-mail." + } + }, + "required": [ + "name", + "emailAddress" + ] + }, + "SmsReceiver": { + "description": "An SMS receiver.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the SMS receiver. Names must be unique across all receivers within a tenant action group." + }, + "countryCode": { + "type": "string", + "description": "The country code of the SMS receiver." + }, + "phoneNumber": { + "type": "string", + "description": "The phone number of the SMS receiver." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/ReceiverStatus", + "description": "The status of the receiver." + } + }, + "required": [ + "name", + "countryCode", + "phoneNumber" + ] + }, + "WebhookReceiver": { + "description": "A webhook receiver.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the webhook receiver. Names must be unique across all receivers within a tenant action group." + }, + "serviceUri": { + "type": "string", + "description": "The URI where webhooks should be sent." + }, + "useCommonAlertSchema": { + "type": "boolean", + "default": false, + "description": "Indicates whether to use common alert schema." + }, + "useAadAuth": { + "type": "boolean", + "default": false, + "description": "Indicates whether or not use AAD authentication." + }, + "objectId": { + "type": "string", + "description": "Indicates the webhook app object Id for aad auth." + }, + "identifierUri": { + "type": "string", + "description": "Indicates the identifier uri for aad auth." + }, + "tenantId": { + "type": "string", + "description": "Indicates the tenant id for aad auth." + } + }, + "required": [ + "name", + "serviceUri" + ] + }, + "AzureAppPushReceiver": { + "description": "The Azure mobile App push notification receiver.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the Azure mobile app push receiver. Names must be unique across all receivers within a tenant action group." + }, + "emailAddress": { + "type": "string", + "description": "The email address registered for the Azure mobile app." + } + }, + "required": [ + "name", + "emailAddress" + ] + }, + "VoiceReceiver": { + "description": "A voice receiver.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the voice receiver. Names must be unique across all receivers within a tenant action group." + }, + "countryCode": { + "type": "string", + "description": "The country code of the voice receiver." + }, + "phoneNumber": { + "type": "string", + "description": "The phone number of the voice receiver." + } + }, + "required": [ + "name", + "countryCode", + "phoneNumber" + ] + }, + "ReceiverStatus": { + "type": "string", + "enum": [ + "NotSpecified", + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ReceiverStatus", + "modelAsString": false + }, + "description": "Indicates the status of the receiver. Receivers that are not Enabled will not receive any communications." + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "ActionGroupPatchBody": { + "description": "A tenant action group object for the body of patch operations.", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ActionGroupPatch", + "description": "The action group settings for an update operation." + } + } + }, + "ActionGroupPatch": { + "description": "A tenant action group for patch operations.", + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "default": true, + "description": "Indicates whether this tenant action group is enabled. If a tenant action group is not enabled, then none of its actions will be activated." + } + } + } + }, + "parameters": { + "ManagementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "required": true, + "type": "string", + "description": "The management group id.", + "x-ms-parameter-location": "method" + }, + "ActionGroupNameParameter": { + "name": "tenantActionGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z][A-Za-z0-9]*$", + "minLength": 1, + "maxLength": 260, + "description": "The name of the action group.", + "x-ms-parameter-location": "method" + }, + "NotificationIdParameter": { + "name": "notificationId", + "in": "path", + "required": true, + "type": "string", + "description": "The notification id", + "x-ms-parameter-location": "method" + }, + "TenantIdParameter": { + "name": "x-ms-client-tenant-id", + "in": "header", + "description": "The tenant ID of the client making the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 51f6f7a171d7..e04a161f0a47 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -37,6 +37,14 @@ directive: reason: 'There are open issues (bugs) in the validator affecting some of the examples and since there is no way to selectively disable the validation for a particular example or paths, all of the example validation is being turned off.' ``` +### Tag: package-2023-05-01-preview-only + +These settings apply only when `--tag=package-2023-05-01-preview-only` is specified on the command line + +``` yaml $(tag) == 'package-2023-05-01-preview-only' +input-file: +- Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_API.json +``` ### Tag: package-2023-04 @@ -54,7 +62,7 @@ input-file: - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json - Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json - Microsoft.Insights/stable/2023-01-01/actionGroups_API.json - - Microsoft.Insights/preview/2023-03-01-preview/tenantActionGroups_API.json + - Microsoft.Insights/preview/2023-05-01-preview/tenantActionGroups_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 From 9a20afc353d601769460d42fd13475eecbe61e7d Mon Sep 17 00:00:00 2001 From: kazrael2119 <98569699+kazrael2119@users.noreply.github.com> Date: Mon, 15 May 2023 15:06:42 +0800 Subject: [PATCH 77/79] update mysql readme.typescript (#23989) --- specification/mysql/resource-manager/readme.typescript.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/mysql/resource-manager/readme.typescript.md b/specification/mysql/resource-manager/readme.typescript.md index 00af052d891b..ea1a9cdecd02 100644 --- a/specification/mysql/resource-manager/readme.typescript.md +++ b/specification/mysql/resource-manager/readme.typescript.md @@ -9,12 +9,12 @@ typescript: generate-metadata: true ``` -### Tag: package-flexibleserver-2021-05-01 and TypeScript +### Tag: package-flexibleserver-2022-09-30-preview and TypeScript -These settings apply only when `--tag=package-flexibleserver-2021-05-01 --typescript` is specified on the command line. +These settings apply only when `--tag=package-flexibleserver-2022-09-30-preview --typescript` is specified on the command line. Please also specify `--typescript-sdks-folder=`. -``` yaml $(tag) == 'package-flexibleserver-2021-05-01' && $(typescript) +``` yaml $(tag) == 'package-flexibleserver-2022-09-30-preview' && $(typescript) title: MySQLManagementFlexibleServerClient package-name: "@azure/arm-mysql-flexible" output-folder: "$(typescript-sdks-folder)/sdk/mysql/arm-mysql-flexible/" From 05595b52cb0f5ebdd743915650650ed2aadd0f6e Mon Sep 17 00:00:00 2001 From: Avani Gupta Date: Mon, 15 May 2023 09:36:44 -0700 Subject: [PATCH 78/79] Update mentionees for AppConfig service (#23957) Update mentionees for AppConfig service --- .github/fabricbot.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/fabricbot.json b/.github/fabricbot.json index f3b71c6c9d6d..924817095779 100644 --- a/.github/fabricbot.json +++ b/.github/fabricbot.json @@ -1178,7 +1178,7 @@ "App Configuration" ], "mentionees": [ - "shenmuxiaosen", + "jiayi11", "avanigupta" ] }, From bbbd0e31d0c279b8b044a4ad835194e914357fa9 Mon Sep 17 00:00:00 2001 From: Mahsa Sadi Date: Mon, 15 May 2023 10:44:28 -0700 Subject: [PATCH 79/79] rev -1 --- .../preview/2023-03-01-preview/definitions.json | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json index 3942e721bd09..8ec5f1c628af 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2023-03-01-preview/definitions.json @@ -1950,8 +1950,7 @@ "single", "pool" ], - "description": "Type of the backend. A backend can be either Single or Pool.", - "x-apim-code-nillable": true + "description": "Type of the backend. A backend can be either Single or Pool." } }, "description": "Backend entity base Parameter set." @@ -2373,8 +2372,7 @@ "properties": { "id": { "type": "string", - "description": "The unique id of the backend entity. The ID should refer to an already existing backend entity.", - "x-apim-code-resourceId": "/backends/{backendId}" + "description": "The unique id of the backend entity. The ID should refer to an already existing backend entity." } } },